Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/arm-network

Index

Classes

Interfaces

Type aliases

Variables

Object literals

Type aliases

Access

Access: "Allow" | "Deny"

Defines values for Access. Possible values include: 'Allow', 'Deny'

readonly
enum

{string}

ApplicationGatewayBackendHealthServerHealth

ApplicationGatewayBackendHealthServerHealth: "Unknown" | "Up" | "Down" | "Partial" | "Draining"

Defines values for ApplicationGatewayBackendHealthServerHealth. Possible values include: 'Unknown', 'Up', 'Down', 'Partial', 'Draining'

readonly
enum

{string}

ApplicationGatewayCookieBasedAffinity

ApplicationGatewayCookieBasedAffinity: "Enabled" | "Disabled"

Defines values for ApplicationGatewayCookieBasedAffinity. Possible values include: 'Enabled', 'Disabled'

readonly
enum

{string}

ApplicationGatewayCustomErrorStatusCode

ApplicationGatewayCustomErrorStatusCode: "HttpStatus403" | "HttpStatus502"

Defines values for ApplicationGatewayCustomErrorStatusCode. Possible values include: 'HttpStatus403', 'HttpStatus502'

readonly
enum

{string}

ApplicationGatewayFirewallMode

ApplicationGatewayFirewallMode: "Detection" | "Prevention"

Defines values for ApplicationGatewayFirewallMode. Possible values include: 'Detection', 'Prevention'

readonly
enum

{string}

ApplicationGatewayOperationalState

ApplicationGatewayOperationalState: "Stopped" | "Starting" | "Running" | "Stopping"

Defines values for ApplicationGatewayOperationalState. Possible values include: 'Stopped', 'Starting', 'Running', 'Stopping'

readonly
enum

{string}

ApplicationGatewayProtocol

ApplicationGatewayProtocol: "Http" | "Https"

Defines values for ApplicationGatewayProtocol. Possible values include: 'Http', 'Https'

readonly
enum

{string}

ApplicationGatewayRedirectType

ApplicationGatewayRedirectType: "Permanent" | "Found" | "SeeOther" | "Temporary"

Defines values for ApplicationGatewayRedirectType. Possible values include: 'Permanent', 'Found', 'SeeOther', 'Temporary'

readonly
enum

{string}

ApplicationGatewayRequestRoutingRuleType

ApplicationGatewayRequestRoutingRuleType: "Basic" | "PathBasedRouting"

Defines values for ApplicationGatewayRequestRoutingRuleType. Possible values include: 'Basic', 'PathBasedRouting'

readonly
enum

{string}

ApplicationGatewaySkuName

ApplicationGatewaySkuName: "Standard_Small" | "Standard_Medium" | "Standard_Large" | "WAF_Medium" | "WAF_Large" | "Standard_v2" | "WAF_v2"

Defines values for ApplicationGatewaySkuName. Possible values include: 'Standard_Small', 'Standard_Medium', 'Standard_Large', 'WAF_Medium', 'WAF_Large', 'Standard_v2', 'WAF_v2'

readonly
enum

{string}

ApplicationGatewaySslCipherSuite

ApplicationGatewaySslCipherSuite: "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384" | "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_DHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_AES_256_GCM_SHA384" | "TLS_RSA_WITH_AES_128_GCM_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA256" | "TLS_RSA_WITH_AES_128_CBC_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA" | "TLS_RSA_WITH_AES_128_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_3DES_EDE_CBC_SHA"

Defines values for ApplicationGatewaySslCipherSuite. Possible values include: 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384', 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256', 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA', 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA', 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384', 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256', 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA', 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA', 'TLS_RSA_WITH_AES_256_GCM_SHA384', 'TLS_RSA_WITH_AES_128_GCM_SHA256', 'TLS_RSA_WITH_AES_256_CBC_SHA256', 'TLS_RSA_WITH_AES_128_CBC_SHA256', 'TLS_RSA_WITH_AES_256_CBC_SHA', 'TLS_RSA_WITH_AES_128_CBC_SHA', 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384', 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256', 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384', 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256', 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA', 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA', 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256', 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256', 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA', 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA', 'TLS_RSA_WITH_3DES_EDE_CBC_SHA'

readonly
enum

{string}

ApplicationGatewaySslPolicyName

ApplicationGatewaySslPolicyName: "AppGwSslPolicy20150501" | "AppGwSslPolicy20170401" | "AppGwSslPolicy20170401S"

Defines values for ApplicationGatewaySslPolicyName. Possible values include: 'AppGwSslPolicy20150501', 'AppGwSslPolicy20170401', 'AppGwSslPolicy20170401S'

readonly
enum

{string}

ApplicationGatewaySslPolicyType

ApplicationGatewaySslPolicyType: "Predefined" | "Custom"

Defines values for ApplicationGatewaySslPolicyType. Possible values include: 'Predefined', 'Custom'

readonly
enum

{string}

ApplicationGatewaySslProtocol

ApplicationGatewaySslProtocol: "TLSv1_0" | "TLSv1_1" | "TLSv1_2"

Defines values for ApplicationGatewaySslProtocol. Possible values include: 'TLSv1_0', 'TLSv1_1', 'TLSv1_2'

readonly
enum

{string}

ApplicationGatewayTier

ApplicationGatewayTier: "Standard" | "WAF" | "Standard_v2" | "WAF_v2"

Defines values for ApplicationGatewayTier. Possible values include: 'Standard', 'WAF', 'Standard_v2', 'WAF_v2'

readonly
enum

{string}

ApplicationGatewaysBackendHealthOnDemandResponse

ApplicationGatewaysBackendHealthOnDemandResponse: ApplicationGatewayBackendHealthOnDemand & object

Contains response data for the backendHealthOnDemand operation.

ApplicationGatewaysBackendHealthResponse

ApplicationGatewaysBackendHealthResponse: ApplicationGatewayBackendHealth & object

Contains response data for the backendHealth operation.

ApplicationGatewaysBeginBackendHealthOnDemandResponse

ApplicationGatewaysBeginBackendHealthOnDemandResponse: ApplicationGatewayBackendHealthOnDemand & object

Contains response data for the beginBackendHealthOnDemand operation.

ApplicationGatewaysBeginBackendHealthResponse

ApplicationGatewaysBeginBackendHealthResponse: ApplicationGatewayBackendHealth & object

Contains response data for the beginBackendHealth operation.

ApplicationGatewaysBeginCreateOrUpdateResponse

ApplicationGatewaysBeginCreateOrUpdateResponse: ApplicationGateway & object

Contains response data for the beginCreateOrUpdate operation.

ApplicationGatewaysBeginUpdateTagsResponse

ApplicationGatewaysBeginUpdateTagsResponse: ApplicationGateway & object

Contains response data for the beginUpdateTags operation.

ApplicationGatewaysCreateOrUpdateResponse

ApplicationGatewaysCreateOrUpdateResponse: ApplicationGateway & object

Contains response data for the createOrUpdate operation.

ApplicationGatewaysGetResponse

ApplicationGatewaysGetResponse: ApplicationGateway & object

Contains response data for the get operation.

ApplicationGatewaysGetSslPredefinedPolicyResponse

ApplicationGatewaysGetSslPredefinedPolicyResponse: ApplicationGatewaySslPredefinedPolicy & object

Contains response data for the getSslPredefinedPolicy operation.

ApplicationGatewaysListAllNextResponse

ApplicationGatewaysListAllNextResponse: ApplicationGatewayListResult & object

Contains response data for the listAllNext operation.

ApplicationGatewaysListAllResponse

ApplicationGatewaysListAllResponse: ApplicationGatewayListResult & object

Contains response data for the listAll operation.

ApplicationGatewaysListAvailableRequestHeadersResponse

ApplicationGatewaysListAvailableRequestHeadersResponse: Array<string> & object

Contains response data for the listAvailableRequestHeaders operation.

ApplicationGatewaysListAvailableResponseHeadersResponse

ApplicationGatewaysListAvailableResponseHeadersResponse: Array<string> & object

Contains response data for the listAvailableResponseHeaders operation.

ApplicationGatewaysListAvailableServerVariablesResponse

ApplicationGatewaysListAvailableServerVariablesResponse: Array<string> & object

Contains response data for the listAvailableServerVariables operation.

ApplicationGatewaysListAvailableSslOptionsResponse

ApplicationGatewaysListAvailableSslOptionsResponse: ApplicationGatewayAvailableSslOptions & object

Contains response data for the listAvailableSslOptions operation.

ApplicationGatewaysListAvailableSslPredefinedPoliciesNextResponse

ApplicationGatewaysListAvailableSslPredefinedPoliciesNextResponse: ApplicationGatewayAvailableSslPredefinedPolicies & object

Contains response data for the listAvailableSslPredefinedPoliciesNext operation.

ApplicationGatewaysListAvailableSslPredefinedPoliciesResponse

ApplicationGatewaysListAvailableSslPredefinedPoliciesResponse: ApplicationGatewayAvailableSslPredefinedPolicies & object

Contains response data for the listAvailableSslPredefinedPolicies operation.

ApplicationGatewaysListAvailableWafRuleSetsResponse

ApplicationGatewaysListAvailableWafRuleSetsResponse: ApplicationGatewayAvailableWafRuleSetsResult & object

Contains response data for the listAvailableWafRuleSets operation.

ApplicationGatewaysListNextResponse

ApplicationGatewaysListNextResponse: ApplicationGatewayListResult & object

Contains response data for the listNext operation.

ApplicationGatewaysListResponse

ApplicationGatewaysListResponse: ApplicationGatewayListResult & object

Contains response data for the list operation.

ApplicationGatewaysUpdateTagsResponse

ApplicationGatewaysUpdateTagsResponse: ApplicationGateway & object

Contains response data for the updateTags operation.

ApplicationSecurityGroupsBeginCreateOrUpdateResponse

ApplicationSecurityGroupsBeginCreateOrUpdateResponse: ApplicationSecurityGroup & object

Contains response data for the beginCreateOrUpdate operation.

ApplicationSecurityGroupsBeginUpdateTagsResponse

ApplicationSecurityGroupsBeginUpdateTagsResponse: ApplicationSecurityGroup & object

Contains response data for the beginUpdateTags operation.

ApplicationSecurityGroupsCreateOrUpdateResponse

ApplicationSecurityGroupsCreateOrUpdateResponse: ApplicationSecurityGroup & object

Contains response data for the createOrUpdate operation.

ApplicationSecurityGroupsGetResponse

ApplicationSecurityGroupsGetResponse: ApplicationSecurityGroup & object

Contains response data for the get operation.

ApplicationSecurityGroupsListAllNextResponse

ApplicationSecurityGroupsListAllNextResponse: ApplicationSecurityGroupListResult & object

Contains response data for the listAllNext operation.

ApplicationSecurityGroupsListAllResponse

ApplicationSecurityGroupsListAllResponse: ApplicationSecurityGroupListResult & object

Contains response data for the listAll operation.

ApplicationSecurityGroupsListNextResponse

ApplicationSecurityGroupsListNextResponse: ApplicationSecurityGroupListResult & object

Contains response data for the listNext operation.

ApplicationSecurityGroupsListResponse

ApplicationSecurityGroupsListResponse: ApplicationSecurityGroupListResult & object

Contains response data for the list operation.

ApplicationSecurityGroupsUpdateTagsResponse

ApplicationSecurityGroupsUpdateTagsResponse: ApplicationSecurityGroup & object

Contains response data for the updateTags operation.

AssociationType

AssociationType: "Associated" | "Contains"

Defines values for AssociationType. Possible values include: 'Associated', 'Contains'

readonly
enum

{string}

AuthenticationMethod

AuthenticationMethod: "EAPTLS" | "EAPMSCHAPv2"

Defines values for AuthenticationMethod. Possible values include: 'EAPTLS', 'EAPMSCHAPv2'

readonly
enum

{string}

AuthorizationUseStatus

AuthorizationUseStatus: "Available" | "InUse"

Defines values for AuthorizationUseStatus. Possible values include: 'Available', 'InUse'

readonly
enum

{string}

AvailableDelegationsListNextResponse

AvailableDelegationsListNextResponse: AvailableDelegationsResult & object

Contains response data for the listNext operation.

AvailableDelegationsListResponse

AvailableDelegationsListResponse: AvailableDelegationsResult & object

Contains response data for the list operation.

AvailableEndpointServicesListNextResponse

AvailableEndpointServicesListNextResponse: EndpointServicesListResult & object

Contains response data for the listNext operation.

AvailableEndpointServicesListResponse

AvailableEndpointServicesListResponse: EndpointServicesListResult & object

Contains response data for the list operation.

AvailablePrivateEndpointTypesListNextResponse

AvailablePrivateEndpointTypesListNextResponse: AvailablePrivateEndpointTypesResult & object

Contains response data for the listNext operation.

AvailablePrivateEndpointTypesListResponse

AvailablePrivateEndpointTypesListResponse: AvailablePrivateEndpointTypesResult & object

Contains response data for the list operation.

AvailableResourceGroupDelegationsListNextResponse

AvailableResourceGroupDelegationsListNextResponse: AvailableDelegationsResult & object

Contains response data for the listNext operation.

AvailableResourceGroupDelegationsListResponse

AvailableResourceGroupDelegationsListResponse: AvailableDelegationsResult & object

Contains response data for the list operation.

AvailableResourceGroupPrivateEndpointTypesListNextResponse

AvailableResourceGroupPrivateEndpointTypesListNextResponse: AvailablePrivateEndpointTypesResult & object

Contains response data for the listNext operation.

AvailableResourceGroupPrivateEndpointTypesListResponse

AvailableResourceGroupPrivateEndpointTypesListResponse: AvailablePrivateEndpointTypesResult & object

Contains response data for the list operation.

AzureFirewallApplicationRuleProtocolType

AzureFirewallApplicationRuleProtocolType: "Http" | "Https"

Defines values for AzureFirewallApplicationRuleProtocolType. Possible values include: 'Http', 'Https'

readonly
enum

{string}

AzureFirewallFqdnTagsListAllNextResponse

AzureFirewallFqdnTagsListAllNextResponse: AzureFirewallFqdnTagListResult & object

Contains response data for the listAllNext operation.

AzureFirewallFqdnTagsListAllResponse

AzureFirewallFqdnTagsListAllResponse: AzureFirewallFqdnTagListResult & object

Contains response data for the listAll operation.

AzureFirewallNatRCActionType

AzureFirewallNatRCActionType: "Snat" | "Dnat"

Defines values for AzureFirewallNatRCActionType. Possible values include: 'Snat', 'Dnat'

readonly
enum

{string}

AzureFirewallNetworkRuleProtocol

AzureFirewallNetworkRuleProtocol: "TCP" | "UDP" | "Any" | "ICMP"

Defines values for AzureFirewallNetworkRuleProtocol. Possible values include: 'TCP', 'UDP', 'Any', 'ICMP'

readonly
enum

{string}

AzureFirewallRCActionType

AzureFirewallRCActionType: "Allow" | "Deny"

Defines values for AzureFirewallRCActionType. Possible values include: 'Allow', 'Deny'

readonly
enum

{string}

AzureFirewallThreatIntelMode

AzureFirewallThreatIntelMode: "Alert" | "Deny" | "Off"

Defines values for AzureFirewallThreatIntelMode. Possible values include: 'Alert', 'Deny', 'Off'

readonly
enum

{string}

AzureFirewallsBeginCreateOrUpdateResponse

AzureFirewallsBeginCreateOrUpdateResponse: AzureFirewall & object

Contains response data for the beginCreateOrUpdate operation.

AzureFirewallsCreateOrUpdateResponse

AzureFirewallsCreateOrUpdateResponse: AzureFirewall & object

Contains response data for the createOrUpdate operation.

AzureFirewallsGetResponse

AzureFirewallsGetResponse: AzureFirewall & object

Contains response data for the get operation.

AzureFirewallsListAllNextResponse

AzureFirewallsListAllNextResponse: AzureFirewallListResult & object

Contains response data for the listAllNext operation.

AzureFirewallsListAllResponse

AzureFirewallsListAllResponse: AzureFirewallListResult & object

Contains response data for the listAll operation.

AzureFirewallsListNextResponse

AzureFirewallsListNextResponse: AzureFirewallListResult & object

Contains response data for the listNext operation.

AzureFirewallsListResponse

AzureFirewallsListResponse: AzureFirewallListResult & object

Contains response data for the list operation.

BastionHostsBeginCreateOrUpdateResponse

BastionHostsBeginCreateOrUpdateResponse: BastionHost & object

Contains response data for the beginCreateOrUpdate operation.

BastionHostsCreateOrUpdateResponse

BastionHostsCreateOrUpdateResponse: BastionHost & object

Contains response data for the createOrUpdate operation.

BastionHostsGetResponse

BastionHostsGetResponse: BastionHost & object

Contains response data for the get operation.

BastionHostsListByResourceGroupNextResponse

BastionHostsListByResourceGroupNextResponse: BastionHostListResult & object

Contains response data for the listByResourceGroupNext operation.

BastionHostsListByResourceGroupResponse

BastionHostsListByResourceGroupResponse: BastionHostListResult & object

Contains response data for the listByResourceGroup operation.

BastionHostsListNextResponse

BastionHostsListNextResponse: BastionHostListResult & object

Contains response data for the listNext operation.

BastionHostsListResponse

BastionHostsListResponse: BastionHostListResult & object

Contains response data for the list operation.

BgpPeerState

BgpPeerState: "Unknown" | "Stopped" | "Idle" | "Connecting" | "Connected"

Defines values for BgpPeerState. Possible values include: 'Unknown', 'Stopped', 'Idle', 'Connecting', 'Connected'

readonly
enum

{string}

BgpServiceCommunitiesListNextResponse

BgpServiceCommunitiesListNextResponse: BgpServiceCommunityListResult & object

Contains response data for the listNext operation.

BgpServiceCommunitiesListResponse

BgpServiceCommunitiesListResponse: BgpServiceCommunityListResult & object

Contains response data for the list operation.

CheckDnsNameAvailabilityResponse

CheckDnsNameAvailabilityResponse: DnsNameAvailabilityResult & object

Contains response data for the checkDnsNameAvailability operation.

CircuitConnectionStatus

CircuitConnectionStatus: "Connected" | "Connecting" | "Disconnected"

Defines values for CircuitConnectionStatus. Possible values include: 'Connected', 'Connecting', 'Disconnected'

readonly
enum

{string}

ConnectionMonitorSourceStatus

ConnectionMonitorSourceStatus: "Unknown" | "Active" | "Inactive"

Defines values for ConnectionMonitorSourceStatus. Possible values include: 'Unknown', 'Active', 'Inactive'

readonly
enum

{string}

ConnectionMonitorsBeginCreateOrUpdateResponse

ConnectionMonitorsBeginCreateOrUpdateResponse: ConnectionMonitorResult & object

Contains response data for the beginCreateOrUpdate operation.

ConnectionMonitorsBeginQueryResponse

ConnectionMonitorsBeginQueryResponse: ConnectionMonitorQueryResult & object

Contains response data for the beginQuery operation.

ConnectionMonitorsCreateOrUpdateResponse

ConnectionMonitorsCreateOrUpdateResponse: ConnectionMonitorResult & object

Contains response data for the createOrUpdate operation.

ConnectionMonitorsGetResponse

ConnectionMonitorsGetResponse: ConnectionMonitorResult & object

Contains response data for the get operation.

ConnectionMonitorsListResponse

ConnectionMonitorsListResponse: ConnectionMonitorListResult & object

Contains response data for the list operation.

ConnectionMonitorsQueryResponse

ConnectionMonitorsQueryResponse: ConnectionMonitorQueryResult & object

Contains response data for the query operation.

ConnectionState

ConnectionState: "Reachable" | "Unreachable" | "Unknown"

Defines values for ConnectionState. Possible values include: 'Reachable', 'Unreachable', 'Unknown'

readonly
enum

{string}

ConnectionStatus

ConnectionStatus: "Unknown" | "Connected" | "Disconnected" | "Degraded"

Defines values for ConnectionStatus. Possible values include: 'Unknown', 'Connected', 'Disconnected', 'Degraded'

readonly
enum

{string}

DdosCustomPoliciesBeginCreateOrUpdateResponse

DdosCustomPoliciesBeginCreateOrUpdateResponse: DdosCustomPolicy & object

Contains response data for the beginCreateOrUpdate operation.

DdosCustomPoliciesBeginUpdateTagsResponse

DdosCustomPoliciesBeginUpdateTagsResponse: DdosCustomPolicy & object

Contains response data for the beginUpdateTags operation.

DdosCustomPoliciesCreateOrUpdateResponse

DdosCustomPoliciesCreateOrUpdateResponse: DdosCustomPolicy & object

Contains response data for the createOrUpdate operation.

DdosCustomPoliciesGetResponse

DdosCustomPoliciesGetResponse: DdosCustomPolicy & object

Contains response data for the get operation.

DdosCustomPoliciesUpdateTagsResponse

DdosCustomPoliciesUpdateTagsResponse: DdosCustomPolicy & object

Contains response data for the updateTags operation.

DdosCustomPolicyProtocol

DdosCustomPolicyProtocol: "Tcp" | "Udp" | "Syn"

Defines values for DdosCustomPolicyProtocol. Possible values include: 'Tcp', 'Udp', 'Syn'

readonly
enum

{string}

DdosCustomPolicyTriggerSensitivityOverride

DdosCustomPolicyTriggerSensitivityOverride: "Relaxed" | "Low" | "Default" | "High"

Defines values for DdosCustomPolicyTriggerSensitivityOverride. Possible values include: 'Relaxed', 'Low', 'Default', 'High'

readonly
enum

{string}

DdosProtectionPlansBeginCreateOrUpdateResponse

DdosProtectionPlansBeginCreateOrUpdateResponse: DdosProtectionPlan & object

Contains response data for the beginCreateOrUpdate operation.

DdosProtectionPlansBeginUpdateTagsResponse

DdosProtectionPlansBeginUpdateTagsResponse: DdosProtectionPlan & object

Contains response data for the beginUpdateTags operation.

DdosProtectionPlansCreateOrUpdateResponse

DdosProtectionPlansCreateOrUpdateResponse: DdosProtectionPlan & object

Contains response data for the createOrUpdate operation.

DdosProtectionPlansGetResponse

DdosProtectionPlansGetResponse: DdosProtectionPlan & object

Contains response data for the get operation.

DdosProtectionPlansListByResourceGroupNextResponse

DdosProtectionPlansListByResourceGroupNextResponse: DdosProtectionPlanListResult & object

Contains response data for the listByResourceGroupNext operation.

DdosProtectionPlansListByResourceGroupResponse

DdosProtectionPlansListByResourceGroupResponse: DdosProtectionPlanListResult & object

Contains response data for the listByResourceGroup operation.

DdosProtectionPlansListNextResponse

DdosProtectionPlansListNextResponse: DdosProtectionPlanListResult & object

Contains response data for the listNext operation.

DdosProtectionPlansListResponse

DdosProtectionPlansListResponse: DdosProtectionPlanListResult & object

Contains response data for the list operation.

DdosProtectionPlansUpdateTagsResponse

DdosProtectionPlansUpdateTagsResponse: DdosProtectionPlan & object

Contains response data for the updateTags operation.

DdosSettingsProtectionCoverage

DdosSettingsProtectionCoverage: "Basic" | "Standard"

Defines values for DdosSettingsProtectionCoverage. Possible values include: 'Basic', 'Standard'

readonly
enum

{string}

DefaultSecurityRulesGetResponse

DefaultSecurityRulesGetResponse: SecurityRule & object

Contains response data for the get operation.

DefaultSecurityRulesListNextResponse

DefaultSecurityRulesListNextResponse: SecurityRuleListResult & object

Contains response data for the listNext operation.

DefaultSecurityRulesListResponse

DefaultSecurityRulesListResponse: SecurityRuleListResult & object

Contains response data for the list operation.

DhGroup

DhGroup: "None" | "DHGroup1" | "DHGroup2" | "DHGroup14" | "DHGroup2048" | "ECP256" | "ECP384" | "DHGroup24"

Defines values for DhGroup. Possible values include: 'None', 'DHGroup1', 'DHGroup2', 'DHGroup14', 'DHGroup2048', 'ECP256', 'ECP384', 'DHGroup24'

readonly
enum

{string}

Direction

Direction: "Inbound" | "Outbound"

Defines values for Direction. Possible values include: 'Inbound', 'Outbound'

readonly
enum

{string}

EffectiveRouteSource

EffectiveRouteSource: "Unknown" | "User" | "VirtualNetworkGateway" | "Default"

Defines values for EffectiveRouteSource. Possible values include: 'Unknown', 'User', 'VirtualNetworkGateway', 'Default'

readonly
enum

{string}

EffectiveRouteState

EffectiveRouteState: "Active" | "Invalid"

Defines values for EffectiveRouteState. Possible values include: 'Active', 'Invalid'

readonly
enum

{string}

EffectiveSecurityRuleProtocol

EffectiveSecurityRuleProtocol: "Tcp" | "Udp" | "All"

Defines values for EffectiveSecurityRuleProtocol. Possible values include: 'Tcp', 'Udp', 'All'

readonly
enum

{string}

EvaluationState

EvaluationState: "NotStarted" | "InProgress" | "Completed"

Defines values for EvaluationState. Possible values include: 'NotStarted', 'InProgress', 'Completed'

readonly
enum

{string}

ExpressRouteCircuitAuthorizationsBeginCreateOrUpdateResponse

ExpressRouteCircuitAuthorizationsBeginCreateOrUpdateResponse: ExpressRouteCircuitAuthorization & object

Contains response data for the beginCreateOrUpdate operation.

ExpressRouteCircuitAuthorizationsCreateOrUpdateResponse

ExpressRouteCircuitAuthorizationsCreateOrUpdateResponse: ExpressRouteCircuitAuthorization & object

Contains response data for the createOrUpdate operation.

ExpressRouteCircuitAuthorizationsGetResponse

ExpressRouteCircuitAuthorizationsGetResponse: ExpressRouteCircuitAuthorization & object

Contains response data for the get operation.

ExpressRouteCircuitAuthorizationsListNextResponse

ExpressRouteCircuitAuthorizationsListNextResponse: AuthorizationListResult & object

Contains response data for the listNext operation.

ExpressRouteCircuitAuthorizationsListResponse

ExpressRouteCircuitAuthorizationsListResponse: AuthorizationListResult & object

Contains response data for the list operation.

ExpressRouteCircuitConnectionsBeginCreateOrUpdateResponse

ExpressRouteCircuitConnectionsBeginCreateOrUpdateResponse: ExpressRouteCircuitConnection & object

Contains response data for the beginCreateOrUpdate operation.

ExpressRouteCircuitConnectionsCreateOrUpdateResponse

ExpressRouteCircuitConnectionsCreateOrUpdateResponse: ExpressRouteCircuitConnection & object

Contains response data for the createOrUpdate operation.

ExpressRouteCircuitConnectionsGetResponse

ExpressRouteCircuitConnectionsGetResponse: ExpressRouteCircuitConnection & object

Contains response data for the get operation.

ExpressRouteCircuitConnectionsListNextResponse

ExpressRouteCircuitConnectionsListNextResponse: ExpressRouteCircuitConnectionListResult & object

Contains response data for the listNext operation.

ExpressRouteCircuitConnectionsListResponse

ExpressRouteCircuitConnectionsListResponse: ExpressRouteCircuitConnectionListResult & object

Contains response data for the list operation.

ExpressRouteCircuitPeeringAdvertisedPublicPrefixState

ExpressRouteCircuitPeeringAdvertisedPublicPrefixState: "NotConfigured" | "Configuring" | "Configured" | "ValidationNeeded"

Defines values for ExpressRouteCircuitPeeringAdvertisedPublicPrefixState. Possible values include: 'NotConfigured', 'Configuring', 'Configured', 'ValidationNeeded'

readonly
enum

{string}

ExpressRouteCircuitPeeringState

ExpressRouteCircuitPeeringState: "Disabled" | "Enabled"

Defines values for ExpressRouteCircuitPeeringState. Possible values include: 'Disabled', 'Enabled'

readonly
enum

{string}

ExpressRouteCircuitPeeringsBeginCreateOrUpdateResponse

ExpressRouteCircuitPeeringsBeginCreateOrUpdateResponse: ExpressRouteCircuitPeering & object

Contains response data for the beginCreateOrUpdate operation.

ExpressRouteCircuitPeeringsCreateOrUpdateResponse

ExpressRouteCircuitPeeringsCreateOrUpdateResponse: ExpressRouteCircuitPeering & object

Contains response data for the createOrUpdate operation.

ExpressRouteCircuitPeeringsGetResponse

ExpressRouteCircuitPeeringsGetResponse: ExpressRouteCircuitPeering & object

Contains response data for the get operation.

ExpressRouteCircuitPeeringsListNextResponse

ExpressRouteCircuitPeeringsListNextResponse: ExpressRouteCircuitPeeringListResult & object

Contains response data for the listNext operation.

ExpressRouteCircuitPeeringsListResponse

ExpressRouteCircuitPeeringsListResponse: ExpressRouteCircuitPeeringListResult & object

Contains response data for the list operation.

ExpressRouteCircuitSkuFamily

ExpressRouteCircuitSkuFamily: "UnlimitedData" | "MeteredData"

Defines values for ExpressRouteCircuitSkuFamily. Possible values include: 'UnlimitedData', 'MeteredData'

readonly
enum

{string}

ExpressRouteCircuitSkuTier

ExpressRouteCircuitSkuTier: "Standard" | "Premium" | "Basic" | "Local"

Defines values for ExpressRouteCircuitSkuTier. Possible values include: 'Standard', 'Premium', 'Basic', 'Local'

readonly
enum

{string}

ExpressRouteCircuitsBeginCreateOrUpdateResponse

ExpressRouteCircuitsBeginCreateOrUpdateResponse: ExpressRouteCircuit & object

Contains response data for the beginCreateOrUpdate operation.

ExpressRouteCircuitsBeginListArpTableResponse

ExpressRouteCircuitsBeginListArpTableResponse: ExpressRouteCircuitsArpTableListResult & object

Contains response data for the beginListArpTable operation.

ExpressRouteCircuitsBeginListRoutesTableResponse

ExpressRouteCircuitsBeginListRoutesTableResponse: ExpressRouteCircuitsRoutesTableListResult & object

Contains response data for the beginListRoutesTable operation.

ExpressRouteCircuitsBeginListRoutesTableSummaryResponse

ExpressRouteCircuitsBeginListRoutesTableSummaryResponse: ExpressRouteCircuitsRoutesTableSummaryListResult & object

Contains response data for the beginListRoutesTableSummary operation.

ExpressRouteCircuitsBeginUpdateTagsResponse

ExpressRouteCircuitsBeginUpdateTagsResponse: ExpressRouteCircuit & object

Contains response data for the beginUpdateTags operation.

ExpressRouteCircuitsCreateOrUpdateResponse

ExpressRouteCircuitsCreateOrUpdateResponse: ExpressRouteCircuit & object

Contains response data for the createOrUpdate operation.

ExpressRouteCircuitsGetPeeringStatsResponse

ExpressRouteCircuitsGetPeeringStatsResponse: ExpressRouteCircuitStats & object

Contains response data for the getPeeringStats operation.

ExpressRouteCircuitsGetResponse

ExpressRouteCircuitsGetResponse: ExpressRouteCircuit & object

Contains response data for the get operation.

ExpressRouteCircuitsGetStatsResponse

ExpressRouteCircuitsGetStatsResponse: ExpressRouteCircuitStats & object

Contains response data for the getStats operation.

ExpressRouteCircuitsListAllNextResponse

ExpressRouteCircuitsListAllNextResponse: ExpressRouteCircuitListResult & object

Contains response data for the listAllNext operation.

ExpressRouteCircuitsListAllResponse

ExpressRouteCircuitsListAllResponse: ExpressRouteCircuitListResult & object

Contains response data for the listAll operation.

ExpressRouteCircuitsListArpTableResponse

ExpressRouteCircuitsListArpTableResponse: ExpressRouteCircuitsArpTableListResult & object

Contains response data for the listArpTable operation.

ExpressRouteCircuitsListNextResponse

ExpressRouteCircuitsListNextResponse: ExpressRouteCircuitListResult & object

Contains response data for the listNext operation.

ExpressRouteCircuitsListResponse

ExpressRouteCircuitsListResponse: ExpressRouteCircuitListResult & object

Contains response data for the list operation.

ExpressRouteCircuitsListRoutesTableResponse

ExpressRouteCircuitsListRoutesTableResponse: ExpressRouteCircuitsRoutesTableListResult & object

Contains response data for the listRoutesTable operation.

ExpressRouteCircuitsListRoutesTableSummaryResponse

ExpressRouteCircuitsListRoutesTableSummaryResponse: ExpressRouteCircuitsRoutesTableSummaryListResult & object

Contains response data for the listRoutesTableSummary operation.

ExpressRouteCircuitsUpdateTagsResponse

ExpressRouteCircuitsUpdateTagsResponse: ExpressRouteCircuit & object

Contains response data for the updateTags operation.

ExpressRouteConnectionsBeginCreateOrUpdateResponse

ExpressRouteConnectionsBeginCreateOrUpdateResponse: ExpressRouteConnection & object

Contains response data for the beginCreateOrUpdate operation.

ExpressRouteConnectionsCreateOrUpdateResponse

ExpressRouteConnectionsCreateOrUpdateResponse: ExpressRouteConnection & object

Contains response data for the createOrUpdate operation.

ExpressRouteConnectionsGetResponse

ExpressRouteConnectionsGetResponse: ExpressRouteConnection & object

Contains response data for the get operation.

ExpressRouteConnectionsListResponse

ExpressRouteConnectionsListResponse: ExpressRouteConnectionList & object

Contains response data for the list operation.

ExpressRouteCrossConnectionPeeringsBeginCreateOrUpdateResponse

ExpressRouteCrossConnectionPeeringsBeginCreateOrUpdateResponse: ExpressRouteCrossConnectionPeering & object

Contains response data for the beginCreateOrUpdate operation.

ExpressRouteCrossConnectionPeeringsCreateOrUpdateResponse

ExpressRouteCrossConnectionPeeringsCreateOrUpdateResponse: ExpressRouteCrossConnectionPeering & object

Contains response data for the createOrUpdate operation.

ExpressRouteCrossConnectionPeeringsGetResponse

ExpressRouteCrossConnectionPeeringsGetResponse: ExpressRouteCrossConnectionPeering & object

Contains response data for the get operation.

ExpressRouteCrossConnectionPeeringsListNextResponse

ExpressRouteCrossConnectionPeeringsListNextResponse: ExpressRouteCrossConnectionPeeringList & object

Contains response data for the listNext operation.

ExpressRouteCrossConnectionPeeringsListResponse

ExpressRouteCrossConnectionPeeringsListResponse: ExpressRouteCrossConnectionPeeringList & object

Contains response data for the list operation.

ExpressRouteCrossConnectionsBeginCreateOrUpdateResponse

ExpressRouteCrossConnectionsBeginCreateOrUpdateResponse: ExpressRouteCrossConnection & object

Contains response data for the beginCreateOrUpdate operation.

ExpressRouteCrossConnectionsBeginListArpTableResponse

ExpressRouteCrossConnectionsBeginListArpTableResponse: ExpressRouteCircuitsArpTableListResult & object

Contains response data for the beginListArpTable operation.

ExpressRouteCrossConnectionsBeginListRoutesTableResponse

ExpressRouteCrossConnectionsBeginListRoutesTableResponse: ExpressRouteCircuitsRoutesTableListResult & object

Contains response data for the beginListRoutesTable operation.

ExpressRouteCrossConnectionsBeginListRoutesTableSummaryResponse

ExpressRouteCrossConnectionsBeginListRoutesTableSummaryResponse: ExpressRouteCrossConnectionsRoutesTableSummaryListResult & object

Contains response data for the beginListRoutesTableSummary operation.

ExpressRouteCrossConnectionsBeginUpdateTagsResponse

ExpressRouteCrossConnectionsBeginUpdateTagsResponse: ExpressRouteCrossConnection & object

Contains response data for the beginUpdateTags operation.

ExpressRouteCrossConnectionsCreateOrUpdateResponse

ExpressRouteCrossConnectionsCreateOrUpdateResponse: ExpressRouteCrossConnection & object

Contains response data for the createOrUpdate operation.

ExpressRouteCrossConnectionsGetResponse

ExpressRouteCrossConnectionsGetResponse: ExpressRouteCrossConnection & object

Contains response data for the get operation.

ExpressRouteCrossConnectionsListArpTableResponse

ExpressRouteCrossConnectionsListArpTableResponse: ExpressRouteCircuitsArpTableListResult & object

Contains response data for the listArpTable operation.

ExpressRouteCrossConnectionsListByResourceGroupNextResponse

ExpressRouteCrossConnectionsListByResourceGroupNextResponse: ExpressRouteCrossConnectionListResult & object

Contains response data for the listByResourceGroupNext operation.

ExpressRouteCrossConnectionsListByResourceGroupResponse

ExpressRouteCrossConnectionsListByResourceGroupResponse: ExpressRouteCrossConnectionListResult & object

Contains response data for the listByResourceGroup operation.

ExpressRouteCrossConnectionsListNextResponse

ExpressRouteCrossConnectionsListNextResponse: ExpressRouteCrossConnectionListResult & object

Contains response data for the listNext operation.

ExpressRouteCrossConnectionsListResponse

ExpressRouteCrossConnectionsListResponse: ExpressRouteCrossConnectionListResult & object

Contains response data for the list operation.

ExpressRouteCrossConnectionsListRoutesTableResponse

ExpressRouteCrossConnectionsListRoutesTableResponse: ExpressRouteCircuitsRoutesTableListResult & object

Contains response data for the listRoutesTable operation.

ExpressRouteCrossConnectionsListRoutesTableSummaryResponse

ExpressRouteCrossConnectionsListRoutesTableSummaryResponse: ExpressRouteCrossConnectionsRoutesTableSummaryListResult & object

Contains response data for the listRoutesTableSummary operation.

ExpressRouteCrossConnectionsUpdateTagsResponse

ExpressRouteCrossConnectionsUpdateTagsResponse: ExpressRouteCrossConnection & object

Contains response data for the updateTags operation.

ExpressRouteGatewaysBeginCreateOrUpdateResponse

ExpressRouteGatewaysBeginCreateOrUpdateResponse: ExpressRouteGateway & object

Contains response data for the beginCreateOrUpdate operation.

ExpressRouteGatewaysCreateOrUpdateResponse

ExpressRouteGatewaysCreateOrUpdateResponse: ExpressRouteGateway & object

Contains response data for the createOrUpdate operation.

ExpressRouteGatewaysGetResponse

ExpressRouteGatewaysGetResponse: ExpressRouteGateway & object

Contains response data for the get operation.

ExpressRouteGatewaysListByResourceGroupResponse

ExpressRouteGatewaysListByResourceGroupResponse: ExpressRouteGatewayList & object

Contains response data for the listByResourceGroup operation.

ExpressRouteGatewaysListBySubscriptionResponse

ExpressRouteGatewaysListBySubscriptionResponse: ExpressRouteGatewayList & object

Contains response data for the listBySubscription operation.

ExpressRouteLinkAdminState

ExpressRouteLinkAdminState: "Enabled" | "Disabled"

Defines values for ExpressRouteLinkAdminState. Possible values include: 'Enabled', 'Disabled'

readonly
enum

{string}

ExpressRouteLinkConnectorType

ExpressRouteLinkConnectorType: "LC" | "SC"

Defines values for ExpressRouteLinkConnectorType. Possible values include: 'LC', 'SC'

readonly
enum

{string}

ExpressRouteLinksGetResponse

ExpressRouteLinksGetResponse: ExpressRouteLink & object

Contains response data for the get operation.

ExpressRouteLinksListNextResponse

ExpressRouteLinksListNextResponse: ExpressRouteLinkListResult & object

Contains response data for the listNext operation.

ExpressRouteLinksListResponse

ExpressRouteLinksListResponse: ExpressRouteLinkListResult & object

Contains response data for the list operation.

ExpressRoutePeeringState

ExpressRoutePeeringState: "Disabled" | "Enabled"

Defines values for ExpressRoutePeeringState. Possible values include: 'Disabled', 'Enabled'

readonly
enum

{string}

ExpressRoutePeeringType

ExpressRoutePeeringType: "AzurePublicPeering" | "AzurePrivatePeering" | "MicrosoftPeering"

Defines values for ExpressRoutePeeringType. Possible values include: 'AzurePublicPeering', 'AzurePrivatePeering', 'MicrosoftPeering'

readonly
enum

{string}

ExpressRoutePortsBeginCreateOrUpdateResponse

ExpressRoutePortsBeginCreateOrUpdateResponse: ExpressRoutePort & object

Contains response data for the beginCreateOrUpdate operation.

ExpressRoutePortsBeginUpdateTagsResponse

ExpressRoutePortsBeginUpdateTagsResponse: ExpressRoutePort & object

Contains response data for the beginUpdateTags operation.

ExpressRoutePortsCreateOrUpdateResponse

ExpressRoutePortsCreateOrUpdateResponse: ExpressRoutePort & object

Contains response data for the createOrUpdate operation.

ExpressRoutePortsEncapsulation

ExpressRoutePortsEncapsulation: "Dot1Q" | "QinQ"

Defines values for ExpressRoutePortsEncapsulation. Possible values include: 'Dot1Q', 'QinQ'

readonly
enum

{string}

ExpressRoutePortsGetResponse

ExpressRoutePortsGetResponse: ExpressRoutePort & object

Contains response data for the get operation.

ExpressRoutePortsListByResourceGroupNextResponse

ExpressRoutePortsListByResourceGroupNextResponse: ExpressRoutePortListResult & object

Contains response data for the listByResourceGroupNext operation.

ExpressRoutePortsListByResourceGroupResponse

ExpressRoutePortsListByResourceGroupResponse: ExpressRoutePortListResult & object

Contains response data for the listByResourceGroup operation.

ExpressRoutePortsListNextResponse

ExpressRoutePortsListNextResponse: ExpressRoutePortListResult & object

Contains response data for the listNext operation.

ExpressRoutePortsListResponse

ExpressRoutePortsListResponse: ExpressRoutePortListResult & object

Contains response data for the list operation.

ExpressRoutePortsLocationsGetResponse

ExpressRoutePortsLocationsGetResponse: ExpressRoutePortsLocation & object

Contains response data for the get operation.

ExpressRoutePortsLocationsListNextResponse

ExpressRoutePortsLocationsListNextResponse: ExpressRoutePortsLocationListResult & object

Contains response data for the listNext operation.

ExpressRoutePortsLocationsListResponse

ExpressRoutePortsLocationsListResponse: ExpressRoutePortsLocationListResult & object

Contains response data for the list operation.

ExpressRoutePortsUpdateTagsResponse

ExpressRoutePortsUpdateTagsResponse: ExpressRoutePort & object

Contains response data for the updateTags operation.

ExpressRouteServiceProvidersListNextResponse

ExpressRouteServiceProvidersListNextResponse: ExpressRouteServiceProviderListResult & object

Contains response data for the listNext operation.

ExpressRouteServiceProvidersListResponse

ExpressRouteServiceProvidersListResponse: ExpressRouteServiceProviderListResult & object

Contains response data for the list operation.

FlowLogFormatType

FlowLogFormatType: "JSON"

Defines values for FlowLogFormatType. Possible values include: 'JSON'

readonly
enum

{string}

HTTPMethod

HTTPMethod: "Get"

Defines values for HTTPMethod. Possible values include: 'Get'

readonly
enum

{string}

HubVirtualNetworkConnectionStatus

HubVirtualNetworkConnectionStatus: "Unknown" | "Connecting" | "Connected" | "NotConnected"

Defines values for HubVirtualNetworkConnectionStatus. Possible values include: 'Unknown', 'Connecting', 'Connected', 'NotConnected'

readonly
enum

{string}

HubVirtualNetworkConnectionsGetResponse

HubVirtualNetworkConnectionsGetResponse: HubVirtualNetworkConnection & object

Contains response data for the get operation.

HubVirtualNetworkConnectionsListNextResponse

HubVirtualNetworkConnectionsListNextResponse: ListHubVirtualNetworkConnectionsResult & object

Contains response data for the listNext operation.

HubVirtualNetworkConnectionsListResponse

HubVirtualNetworkConnectionsListResponse: ListHubVirtualNetworkConnectionsResult & object

Contains response data for the list operation.

IPAllocationMethod

IPAllocationMethod: "Static" | "Dynamic"

Defines values for IPAllocationMethod. Possible values include: 'Static', 'Dynamic'

readonly
enum

{string}

IPVersion

IPVersion: "IPv4" | "IPv6"

Defines values for IPVersion. Possible values include: 'IPv4', 'IPv6'

readonly
enum

{string}

IkeEncryption

IkeEncryption: "DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES256" | "GCMAES128"

Defines values for IkeEncryption. Possible values include: 'DES', 'DES3', 'AES128', 'AES192', 'AES256', 'GCMAES256', 'GCMAES128'

readonly
enum

{string}

IkeIntegrity

IkeIntegrity: "MD5" | "SHA1" | "SHA256" | "SHA384" | "GCMAES256" | "GCMAES128"

Defines values for IkeIntegrity. Possible values include: 'MD5', 'SHA1', 'SHA256', 'SHA384', 'GCMAES256', 'GCMAES128'

readonly
enum

{string}

InboundNatRulesBeginCreateOrUpdateResponse

InboundNatRulesBeginCreateOrUpdateResponse: InboundNatRule & object

Contains response data for the beginCreateOrUpdate operation.

InboundNatRulesCreateOrUpdateResponse

InboundNatRulesCreateOrUpdateResponse: InboundNatRule & object

Contains response data for the createOrUpdate operation.

InboundNatRulesGetResponse

InboundNatRulesGetResponse: InboundNatRule & object

Contains response data for the get operation.

InboundNatRulesListNextResponse

InboundNatRulesListNextResponse: InboundNatRuleListResult & object

Contains response data for the listNext operation.

InboundNatRulesListResponse

InboundNatRulesListResponse: InboundNatRuleListResult & object

Contains response data for the list operation.

IpFlowProtocol

IpFlowProtocol: "TCP" | "UDP"

Defines values for IpFlowProtocol. Possible values include: 'TCP', 'UDP'

readonly
enum

{string}

IpsecEncryption

IpsecEncryption: "None" | "DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES128" | "GCMAES192" | "GCMAES256"

Defines values for IpsecEncryption. Possible values include: 'None', 'DES', 'DES3', 'AES128', 'AES192', 'AES256', 'GCMAES128', 'GCMAES192', 'GCMAES256'

readonly
enum

{string}

IpsecIntegrity

IpsecIntegrity: "MD5" | "SHA1" | "SHA256" | "GCMAES128" | "GCMAES192" | "GCMAES256"

Defines values for IpsecIntegrity. Possible values include: 'MD5', 'SHA1', 'SHA256', 'GCMAES128', 'GCMAES192', 'GCMAES256'

readonly
enum

{string}

IssueType

IssueType: "Unknown" | "AgentStopped" | "GuestFirewall" | "DnsResolution" | "SocketBind" | "NetworkSecurityRule" | "UserDefinedRoute" | "PortThrottled" | "Platform"

Defines values for IssueType. Possible values include: 'Unknown', 'AgentStopped', 'GuestFirewall', 'DnsResolution', 'SocketBind', 'NetworkSecurityRule', 'UserDefinedRoute', 'PortThrottled', 'Platform'

readonly
enum

{string}

LoadBalancerBackendAddressPoolsGetResponse

LoadBalancerBackendAddressPoolsGetResponse: BackendAddressPool & object

Contains response data for the get operation.

LoadBalancerBackendAddressPoolsListNextResponse

LoadBalancerBackendAddressPoolsListNextResponse: LoadBalancerBackendAddressPoolListResult & object

Contains response data for the listNext operation.

LoadBalancerBackendAddressPoolsListResponse

LoadBalancerBackendAddressPoolsListResponse: LoadBalancerBackendAddressPoolListResult & object

Contains response data for the list operation.

LoadBalancerFrontendIPConfigurationsGetResponse

LoadBalancerFrontendIPConfigurationsGetResponse: FrontendIPConfiguration & object

Contains response data for the get operation.

LoadBalancerFrontendIPConfigurationsListNextResponse

LoadBalancerFrontendIPConfigurationsListNextResponse: LoadBalancerFrontendIPConfigurationListResult & object

Contains response data for the listNext operation.

LoadBalancerFrontendIPConfigurationsListResponse

LoadBalancerFrontendIPConfigurationsListResponse: LoadBalancerFrontendIPConfigurationListResult & object

Contains response data for the list operation.

LoadBalancerLoadBalancingRulesGetResponse

LoadBalancerLoadBalancingRulesGetResponse: LoadBalancingRule & object

Contains response data for the get operation.

LoadBalancerLoadBalancingRulesListNextResponse

LoadBalancerLoadBalancingRulesListNextResponse: LoadBalancerLoadBalancingRuleListResult & object

Contains response data for the listNext operation.

LoadBalancerLoadBalancingRulesListResponse

LoadBalancerLoadBalancingRulesListResponse: LoadBalancerLoadBalancingRuleListResult & object

Contains response data for the list operation.

LoadBalancerNetworkInterfacesListNextResponse

LoadBalancerNetworkInterfacesListNextResponse: NetworkInterfaceListResult & object

Contains response data for the listNext operation.

LoadBalancerNetworkInterfacesListResponse

LoadBalancerNetworkInterfacesListResponse: NetworkInterfaceListResult & object

Contains response data for the list operation.

LoadBalancerOutboundRuleProtocol

LoadBalancerOutboundRuleProtocol: "Tcp" | "Udp" | "All"

Defines values for LoadBalancerOutboundRuleProtocol. Possible values include: 'Tcp', 'Udp', 'All'

readonly
enum

{string}

LoadBalancerOutboundRulesGetResponse

LoadBalancerOutboundRulesGetResponse: OutboundRule & object

Contains response data for the get operation.

LoadBalancerOutboundRulesListNextResponse

LoadBalancerOutboundRulesListNextResponse: LoadBalancerOutboundRuleListResult & object

Contains response data for the listNext operation.

LoadBalancerOutboundRulesListResponse

LoadBalancerOutboundRulesListResponse: LoadBalancerOutboundRuleListResult & object

Contains response data for the list operation.

LoadBalancerProbesGetResponse

LoadBalancerProbesGetResponse: Probe & object

Contains response data for the get operation.

LoadBalancerProbesListNextResponse

LoadBalancerProbesListNextResponse: LoadBalancerProbeListResult & object

Contains response data for the listNext operation.

LoadBalancerProbesListResponse

LoadBalancerProbesListResponse: LoadBalancerProbeListResult & object

Contains response data for the list operation.

LoadBalancerSkuName

LoadBalancerSkuName: "Basic" | "Standard"

Defines values for LoadBalancerSkuName. Possible values include: 'Basic', 'Standard'

readonly
enum

{string}

LoadBalancersBeginCreateOrUpdateResponse

LoadBalancersBeginCreateOrUpdateResponse: LoadBalancer & object

Contains response data for the beginCreateOrUpdate operation.

LoadBalancersBeginUpdateTagsResponse

LoadBalancersBeginUpdateTagsResponse: LoadBalancer & object

Contains response data for the beginUpdateTags operation.

LoadBalancersCreateOrUpdateResponse

LoadBalancersCreateOrUpdateResponse: LoadBalancer & object

Contains response data for the createOrUpdate operation.

LoadBalancersGetResponse

LoadBalancersGetResponse: LoadBalancer & object

Contains response data for the get operation.

LoadBalancersListAllNextResponse

LoadBalancersListAllNextResponse: LoadBalancerListResult & object

Contains response data for the listAllNext operation.

LoadBalancersListAllResponse

LoadBalancersListAllResponse: LoadBalancerListResult & object

Contains response data for the listAll operation.

LoadBalancersListNextResponse

LoadBalancersListNextResponse: LoadBalancerListResult & object

Contains response data for the listNext operation.

LoadBalancersListResponse

LoadBalancersListResponse: LoadBalancerListResult & object

Contains response data for the list operation.

LoadBalancersUpdateTagsResponse

LoadBalancersUpdateTagsResponse: LoadBalancer & object

Contains response data for the updateTags operation.

LoadDistribution

LoadDistribution: "Default" | "SourceIP" | "SourceIPProtocol"

Defines values for LoadDistribution. Possible values include: 'Default', 'SourceIP', 'SourceIPProtocol'

readonly
enum

{string}

LocalNetworkGatewaysBeginCreateOrUpdateResponse

LocalNetworkGatewaysBeginCreateOrUpdateResponse: LocalNetworkGateway & object

Contains response data for the beginCreateOrUpdate operation.

LocalNetworkGatewaysBeginUpdateTagsResponse

LocalNetworkGatewaysBeginUpdateTagsResponse: LocalNetworkGateway & object

Contains response data for the beginUpdateTags operation.

LocalNetworkGatewaysCreateOrUpdateResponse

LocalNetworkGatewaysCreateOrUpdateResponse: LocalNetworkGateway & object

Contains response data for the createOrUpdate operation.

LocalNetworkGatewaysGetResponse

LocalNetworkGatewaysGetResponse: LocalNetworkGateway & object

Contains response data for the get operation.

LocalNetworkGatewaysListNextResponse

LocalNetworkGatewaysListNextResponse: LocalNetworkGatewayListResult & object

Contains response data for the listNext operation.

LocalNetworkGatewaysListResponse

LocalNetworkGatewaysListResponse: LocalNetworkGatewayListResult & object

Contains response data for the list operation.

LocalNetworkGatewaysUpdateTagsResponse

LocalNetworkGatewaysUpdateTagsResponse: LocalNetworkGateway & object

Contains response data for the updateTags operation.

NatGatewaySkuName

NatGatewaySkuName: "Standard"

Defines values for NatGatewaySkuName. Possible values include: 'Standard'

readonly
enum

{string}

NatGatewaysBeginCreateOrUpdateResponse

NatGatewaysBeginCreateOrUpdateResponse: NatGateway & object

Contains response data for the beginCreateOrUpdate operation.

NatGatewaysCreateOrUpdateResponse

NatGatewaysCreateOrUpdateResponse: NatGateway & object

Contains response data for the createOrUpdate operation.

NatGatewaysGetResponse

NatGatewaysGetResponse: NatGateway & object

Contains response data for the get operation.

NatGatewaysListAllNextResponse

NatGatewaysListAllNextResponse: NatGatewayListResult & object

Contains response data for the listAllNext operation.

NatGatewaysListAllResponse

NatGatewaysListAllResponse: NatGatewayListResult & object

Contains response data for the listAll operation.

NatGatewaysListNextResponse

NatGatewaysListNextResponse: NatGatewayListResult & object

Contains response data for the listNext operation.

NatGatewaysListResponse

NatGatewaysListResponse: NatGatewayListResult & object

Contains response data for the list operation.

NatGatewaysUpdateTagsResponse

NatGatewaysUpdateTagsResponse: NatGateway & object

Contains response data for the updateTags operation.

NetworkInterfaceIPConfigurationsGetResponse

NetworkInterfaceIPConfigurationsGetResponse: NetworkInterfaceIPConfiguration & object

Contains response data for the get operation.

NetworkInterfaceIPConfigurationsListNextResponse

NetworkInterfaceIPConfigurationsListNextResponse: NetworkInterfaceIPConfigurationListResult & object

Contains response data for the listNext operation.

NetworkInterfaceIPConfigurationsListResponse

NetworkInterfaceIPConfigurationsListResponse: NetworkInterfaceIPConfigurationListResult & object

Contains response data for the list operation.

NetworkInterfaceLoadBalancersListNextResponse

NetworkInterfaceLoadBalancersListNextResponse: NetworkInterfaceLoadBalancerListResult & object

Contains response data for the listNext operation.

NetworkInterfaceLoadBalancersListResponse

NetworkInterfaceLoadBalancersListResponse: NetworkInterfaceLoadBalancerListResult & object

Contains response data for the list operation.

NetworkInterfaceTapConfigurationsBeginCreateOrUpdateResponse

NetworkInterfaceTapConfigurationsBeginCreateOrUpdateResponse: NetworkInterfaceTapConfiguration & object

Contains response data for the beginCreateOrUpdate operation.

NetworkInterfaceTapConfigurationsCreateOrUpdateResponse

NetworkInterfaceTapConfigurationsCreateOrUpdateResponse: NetworkInterfaceTapConfiguration & object

Contains response data for the createOrUpdate operation.

NetworkInterfaceTapConfigurationsGetResponse

NetworkInterfaceTapConfigurationsGetResponse: NetworkInterfaceTapConfiguration & object

Contains response data for the get operation.

NetworkInterfaceTapConfigurationsListNextResponse

NetworkInterfaceTapConfigurationsListNextResponse: NetworkInterfaceTapConfigurationListResult & object

Contains response data for the listNext operation.

NetworkInterfaceTapConfigurationsListResponse

NetworkInterfaceTapConfigurationsListResponse: NetworkInterfaceTapConfigurationListResult & object

Contains response data for the list operation.

NetworkInterfacesBeginCreateOrUpdateResponse

NetworkInterfacesBeginCreateOrUpdateResponse: NetworkInterface & object

Contains response data for the beginCreateOrUpdate operation.

NetworkInterfacesBeginGetEffectiveRouteTableResponse

NetworkInterfacesBeginGetEffectiveRouteTableResponse: EffectiveRouteListResult & object

Contains response data for the beginGetEffectiveRouteTable operation.

NetworkInterfacesBeginListEffectiveNetworkSecurityGroupsResponse

NetworkInterfacesBeginListEffectiveNetworkSecurityGroupsResponse: EffectiveNetworkSecurityGroupListResult & object

Contains response data for the beginListEffectiveNetworkSecurityGroups operation.

NetworkInterfacesBeginUpdateTagsResponse

NetworkInterfacesBeginUpdateTagsResponse: NetworkInterface & object

Contains response data for the beginUpdateTags operation.

NetworkInterfacesCreateOrUpdateResponse

NetworkInterfacesCreateOrUpdateResponse: NetworkInterface & object

Contains response data for the createOrUpdate operation.

NetworkInterfacesGetEffectiveRouteTableResponse

NetworkInterfacesGetEffectiveRouteTableResponse: EffectiveRouteListResult & object

Contains response data for the getEffectiveRouteTable operation.

NetworkInterfacesGetResponse

NetworkInterfacesGetResponse: NetworkInterface & object

Contains response data for the get operation.

NetworkInterfacesGetVirtualMachineScaleSetIpConfigurationResponse

NetworkInterfacesGetVirtualMachineScaleSetIpConfigurationResponse: NetworkInterfaceIPConfiguration & object

Contains response data for the getVirtualMachineScaleSetIpConfiguration operation.

NetworkInterfacesGetVirtualMachineScaleSetNetworkInterfaceResponse

NetworkInterfacesGetVirtualMachineScaleSetNetworkInterfaceResponse: NetworkInterface & object

Contains response data for the getVirtualMachineScaleSetNetworkInterface operation.

NetworkInterfacesListAllNextResponse

NetworkInterfacesListAllNextResponse: NetworkInterfaceListResult & object

Contains response data for the listAllNext operation.

NetworkInterfacesListAllResponse

NetworkInterfacesListAllResponse: NetworkInterfaceListResult & object

Contains response data for the listAll operation.

NetworkInterfacesListEffectiveNetworkSecurityGroupsResponse

NetworkInterfacesListEffectiveNetworkSecurityGroupsResponse: EffectiveNetworkSecurityGroupListResult & object

Contains response data for the listEffectiveNetworkSecurityGroups operation.

NetworkInterfacesListNextResponse

NetworkInterfacesListNextResponse: NetworkInterfaceListResult & object

Contains response data for the listNext operation.

NetworkInterfacesListResponse

NetworkInterfacesListResponse: NetworkInterfaceListResult & object

Contains response data for the list operation.

NetworkInterfacesListVirtualMachineScaleSetIpConfigurationsNextResponse

NetworkInterfacesListVirtualMachineScaleSetIpConfigurationsNextResponse: NetworkInterfaceIPConfigurationListResult & object

Contains response data for the listVirtualMachineScaleSetIpConfigurationsNext operation.

NetworkInterfacesListVirtualMachineScaleSetIpConfigurationsResponse

NetworkInterfacesListVirtualMachineScaleSetIpConfigurationsResponse: NetworkInterfaceIPConfigurationListResult & object

Contains response data for the listVirtualMachineScaleSetIpConfigurations operation.

NetworkInterfacesListVirtualMachineScaleSetNetworkInterfacesNextResponse

NetworkInterfacesListVirtualMachineScaleSetNetworkInterfacesNextResponse: NetworkInterfaceListResult & object

Contains response data for the listVirtualMachineScaleSetNetworkInterfacesNext operation.

NetworkInterfacesListVirtualMachineScaleSetNetworkInterfacesResponse

NetworkInterfacesListVirtualMachineScaleSetNetworkInterfacesResponse: NetworkInterfaceListResult & object

Contains response data for the listVirtualMachineScaleSetNetworkInterfaces operation.

NetworkInterfacesListVirtualMachineScaleSetVMNetworkInterfacesNextResponse

NetworkInterfacesListVirtualMachineScaleSetVMNetworkInterfacesNextResponse: NetworkInterfaceListResult & object

Contains response data for the listVirtualMachineScaleSetVMNetworkInterfacesNext operation.

NetworkInterfacesListVirtualMachineScaleSetVMNetworkInterfacesResponse

NetworkInterfacesListVirtualMachineScaleSetVMNetworkInterfacesResponse: NetworkInterfaceListResult & object

Contains response data for the listVirtualMachineScaleSetVMNetworkInterfaces operation.

NetworkInterfacesUpdateTagsResponse

NetworkInterfacesUpdateTagsResponse: NetworkInterface & object

Contains response data for the updateTags operation.

NetworkOperationStatus

NetworkOperationStatus: "InProgress" | "Succeeded" | "Failed"

Defines values for NetworkOperationStatus. Possible values include: 'InProgress', 'Succeeded', 'Failed'

readonly
enum

{string}

NetworkProfilesCreateOrUpdateResponse

NetworkProfilesCreateOrUpdateResponse: NetworkProfile & object

Contains response data for the createOrUpdate operation.

NetworkProfilesGetResponse

NetworkProfilesGetResponse: NetworkProfile & object

Contains response data for the get operation.

NetworkProfilesListAllNextResponse

NetworkProfilesListAllNextResponse: NetworkProfileListResult & object

Contains response data for the listAllNext operation.

NetworkProfilesListAllResponse

NetworkProfilesListAllResponse: NetworkProfileListResult & object

Contains response data for the listAll operation.

NetworkProfilesListNextResponse

NetworkProfilesListNextResponse: NetworkProfileListResult & object

Contains response data for the listNext operation.

NetworkProfilesListResponse

NetworkProfilesListResponse: NetworkProfileListResult & object

Contains response data for the list operation.

NetworkProfilesUpdateTagsResponse

NetworkProfilesUpdateTagsResponse: NetworkProfile & object

Contains response data for the updateTags operation.

NetworkSecurityGroupsBeginCreateOrUpdateResponse

NetworkSecurityGroupsBeginCreateOrUpdateResponse: NetworkSecurityGroup & object

Contains response data for the beginCreateOrUpdate operation.

NetworkSecurityGroupsBeginUpdateTagsResponse

NetworkSecurityGroupsBeginUpdateTagsResponse: NetworkSecurityGroup & object

Contains response data for the beginUpdateTags operation.

NetworkSecurityGroupsCreateOrUpdateResponse

NetworkSecurityGroupsCreateOrUpdateResponse: NetworkSecurityGroup & object

Contains response data for the createOrUpdate operation.

NetworkSecurityGroupsGetResponse

NetworkSecurityGroupsGetResponse: NetworkSecurityGroup & object

Contains response data for the get operation.

NetworkSecurityGroupsListAllNextResponse

NetworkSecurityGroupsListAllNextResponse: NetworkSecurityGroupListResult & object

Contains response data for the listAllNext operation.

NetworkSecurityGroupsListAllResponse

NetworkSecurityGroupsListAllResponse: NetworkSecurityGroupListResult & object

Contains response data for the listAll operation.

NetworkSecurityGroupsListNextResponse

NetworkSecurityGroupsListNextResponse: NetworkSecurityGroupListResult & object

Contains response data for the listNext operation.

NetworkSecurityGroupsListResponse

NetworkSecurityGroupsListResponse: NetworkSecurityGroupListResult & object

Contains response data for the list operation.

NetworkSecurityGroupsUpdateTagsResponse

NetworkSecurityGroupsUpdateTagsResponse: NetworkSecurityGroup & object

Contains response data for the updateTags operation.

NetworkWatchersBeginCheckConnectivityResponse

NetworkWatchersBeginCheckConnectivityResponse: ConnectivityInformation & object

Contains response data for the beginCheckConnectivity operation.

NetworkWatchersBeginGetAzureReachabilityReportResponse

NetworkWatchersBeginGetAzureReachabilityReportResponse: AzureReachabilityReport & object

Contains response data for the beginGetAzureReachabilityReport operation.

NetworkWatchersBeginGetFlowLogStatusResponse

NetworkWatchersBeginGetFlowLogStatusResponse: FlowLogInformation & object

Contains response data for the beginGetFlowLogStatus operation.

NetworkWatchersBeginGetNetworkConfigurationDiagnosticResponse

NetworkWatchersBeginGetNetworkConfigurationDiagnosticResponse: NetworkConfigurationDiagnosticResponse & object

Contains response data for the beginGetNetworkConfigurationDiagnostic operation.

NetworkWatchersBeginGetNextHopResponse

NetworkWatchersBeginGetNextHopResponse: NextHopResult & object

Contains response data for the beginGetNextHop operation.

NetworkWatchersBeginGetTroubleshootingResponse

NetworkWatchersBeginGetTroubleshootingResponse: TroubleshootingResult & object

Contains response data for the beginGetTroubleshooting operation.

NetworkWatchersBeginGetTroubleshootingResultResponse

NetworkWatchersBeginGetTroubleshootingResultResponse: TroubleshootingResult & object

Contains response data for the beginGetTroubleshootingResult operation.

NetworkWatchersBeginGetVMSecurityRulesResponse

NetworkWatchersBeginGetVMSecurityRulesResponse: SecurityGroupViewResult & object

Contains response data for the beginGetVMSecurityRules operation.

NetworkWatchersBeginListAvailableProvidersResponse

NetworkWatchersBeginListAvailableProvidersResponse: AvailableProvidersList & object

Contains response data for the beginListAvailableProviders operation.

NetworkWatchersBeginSetFlowLogConfigurationResponse

NetworkWatchersBeginSetFlowLogConfigurationResponse: FlowLogInformation & object

Contains response data for the beginSetFlowLogConfiguration operation.

NetworkWatchersBeginVerifyIPFlowResponse

NetworkWatchersBeginVerifyIPFlowResponse: VerificationIPFlowResult & object

Contains response data for the beginVerifyIPFlow operation.

NetworkWatchersCheckConnectivityResponse

NetworkWatchersCheckConnectivityResponse: ConnectivityInformation & object

Contains response data for the checkConnectivity operation.

NetworkWatchersCreateOrUpdateResponse

NetworkWatchersCreateOrUpdateResponse: NetworkWatcher & object

Contains response data for the createOrUpdate operation.

NetworkWatchersGetAzureReachabilityReportResponse

NetworkWatchersGetAzureReachabilityReportResponse: AzureReachabilityReport & object

Contains response data for the getAzureReachabilityReport operation.

NetworkWatchersGetFlowLogStatusResponse

NetworkWatchersGetFlowLogStatusResponse: FlowLogInformation & object

Contains response data for the getFlowLogStatus operation.

NetworkWatchersGetNetworkConfigurationDiagnosticResponse

NetworkWatchersGetNetworkConfigurationDiagnosticResponse: NetworkConfigurationDiagnosticResponse & object

Contains response data for the getNetworkConfigurationDiagnostic operation.

NetworkWatchersGetNextHopResponse

NetworkWatchersGetNextHopResponse: NextHopResult & object

Contains response data for the getNextHop operation.

NetworkWatchersGetResponse

NetworkWatchersGetResponse: NetworkWatcher & object

Contains response data for the get operation.

NetworkWatchersGetTopologyResponse

NetworkWatchersGetTopologyResponse: Topology & object

Contains response data for the getTopology operation.

NetworkWatchersGetTroubleshootingResponse

NetworkWatchersGetTroubleshootingResponse: TroubleshootingResult & object

Contains response data for the getTroubleshooting operation.

NetworkWatchersGetTroubleshootingResultResponse

NetworkWatchersGetTroubleshootingResultResponse: TroubleshootingResult & object

Contains response data for the getTroubleshootingResult operation.

NetworkWatchersGetVMSecurityRulesResponse

NetworkWatchersGetVMSecurityRulesResponse: SecurityGroupViewResult & object

Contains response data for the getVMSecurityRules operation.

NetworkWatchersListAllResponse

NetworkWatchersListAllResponse: NetworkWatcherListResult & object

Contains response data for the listAll operation.

NetworkWatchersListAvailableProvidersResponse

NetworkWatchersListAvailableProvidersResponse: AvailableProvidersList & object

Contains response data for the listAvailableProviders operation.

NetworkWatchersListResponse

NetworkWatchersListResponse: NetworkWatcherListResult & object

Contains response data for the list operation.

NetworkWatchersSetFlowLogConfigurationResponse

NetworkWatchersSetFlowLogConfigurationResponse: FlowLogInformation & object

Contains response data for the setFlowLogConfiguration operation.

NetworkWatchersUpdateTagsResponse

NetworkWatchersUpdateTagsResponse: NetworkWatcher & object

Contains response data for the updateTags operation.

NetworkWatchersVerifyIPFlowResponse

NetworkWatchersVerifyIPFlowResponse: VerificationIPFlowResult & object

Contains response data for the verifyIPFlow operation.

NextHopType

NextHopType: "Internet" | "VirtualAppliance" | "VirtualNetworkGateway" | "VnetLocal" | "HyperNetGateway" | "None"

Defines values for NextHopType. Possible values include: 'Internet', 'VirtualAppliance', 'VirtualNetworkGateway', 'VnetLocal', 'HyperNetGateway', 'None'

readonly
enum

{string}

OfficeTrafficCategory

OfficeTrafficCategory: "Optimize" | "OptimizeAndAllow" | "All" | "None"

Defines values for OfficeTrafficCategory. Possible values include: 'Optimize', 'OptimizeAndAllow', 'All', 'None'

readonly
enum

{string}

OperationsListNextResponse

OperationsListNextResponse: OperationListResult & object

Contains response data for the listNext operation.

OperationsListResponse

OperationsListResponse: OperationListResult & object

Contains response data for the list operation.

Origin

Origin: "Local" | "Inbound" | "Outbound"

Defines values for Origin. Possible values include: 'Local', 'Inbound', 'Outbound'

readonly
enum

{string}

P2sVpnGatewaysBeginCreateOrUpdateResponse

P2sVpnGatewaysBeginCreateOrUpdateResponse: P2SVpnGateway & object

Contains response data for the beginCreateOrUpdate operation.

P2sVpnGatewaysBeginGenerateVpnProfileResponse

P2sVpnGatewaysBeginGenerateVpnProfileResponse: VpnProfileResponse & object

Contains response data for the beginGenerateVpnProfile operation.

P2sVpnGatewaysBeginGetP2sVpnConnectionHealthResponse

P2sVpnGatewaysBeginGetP2sVpnConnectionHealthResponse: P2SVpnGateway & object

Contains response data for the beginGetP2sVpnConnectionHealth operation.

P2sVpnGatewaysBeginUpdateTagsResponse

P2sVpnGatewaysBeginUpdateTagsResponse: P2SVpnGateway & object

Contains response data for the beginUpdateTags operation.

P2sVpnGatewaysCreateOrUpdateResponse

P2sVpnGatewaysCreateOrUpdateResponse: P2SVpnGateway & object

Contains response data for the createOrUpdate operation.

P2sVpnGatewaysGenerateVpnProfileResponse

P2sVpnGatewaysGenerateVpnProfileResponse: VpnProfileResponse & object

Contains response data for the generateVpnProfile operation.

P2sVpnGatewaysGetP2sVpnConnectionHealthResponse

P2sVpnGatewaysGetP2sVpnConnectionHealthResponse: P2SVpnGateway & object

Contains response data for the getP2sVpnConnectionHealth operation.

P2sVpnGatewaysGetResponse

P2sVpnGatewaysGetResponse: P2SVpnGateway & object

Contains response data for the get operation.

P2sVpnGatewaysListByResourceGroupNextResponse

P2sVpnGatewaysListByResourceGroupNextResponse: ListP2SVpnGatewaysResult & object

Contains response data for the listByResourceGroupNext operation.

P2sVpnGatewaysListByResourceGroupResponse

P2sVpnGatewaysListByResourceGroupResponse: ListP2SVpnGatewaysResult & object

Contains response data for the listByResourceGroup operation.

P2sVpnGatewaysListNextResponse

P2sVpnGatewaysListNextResponse: ListP2SVpnGatewaysResult & object

Contains response data for the listNext operation.

P2sVpnGatewaysListResponse

P2sVpnGatewaysListResponse: ListP2SVpnGatewaysResult & object

Contains response data for the list operation.

P2sVpnGatewaysUpdateTagsResponse

P2sVpnGatewaysUpdateTagsResponse: P2SVpnGateway & object

Contains response data for the updateTags operation.

P2sVpnServerConfigurationsBeginCreateOrUpdateResponse

P2sVpnServerConfigurationsBeginCreateOrUpdateResponse: P2SVpnServerConfiguration & object

Contains response data for the beginCreateOrUpdate operation.

P2sVpnServerConfigurationsCreateOrUpdateResponse

P2sVpnServerConfigurationsCreateOrUpdateResponse: P2SVpnServerConfiguration & object

Contains response data for the createOrUpdate operation.

P2sVpnServerConfigurationsGetResponse

P2sVpnServerConfigurationsGetResponse: P2SVpnServerConfiguration & object

Contains response data for the get operation.

P2sVpnServerConfigurationsListByVirtualWanNextResponse

P2sVpnServerConfigurationsListByVirtualWanNextResponse: ListP2SVpnServerConfigurationsResult & object

Contains response data for the listByVirtualWanNext operation.

P2sVpnServerConfigurationsListByVirtualWanResponse

P2sVpnServerConfigurationsListByVirtualWanResponse: ListP2SVpnServerConfigurationsResult & object

Contains response data for the listByVirtualWan operation.

PacketCapturesBeginCreateResponse

PacketCapturesBeginCreateResponse: PacketCaptureResult & object

Contains response data for the beginCreate operation.

PacketCapturesBeginGetStatusResponse

PacketCapturesBeginGetStatusResponse: PacketCaptureQueryStatusResult & object

Contains response data for the beginGetStatus operation.

PacketCapturesCreateResponse

PacketCapturesCreateResponse: PacketCaptureResult & object

Contains response data for the create operation.

PacketCapturesGetResponse

PacketCapturesGetResponse: PacketCaptureResult & object

Contains response data for the get operation.

PacketCapturesGetStatusResponse

PacketCapturesGetStatusResponse: PacketCaptureQueryStatusResult & object

Contains response data for the getStatus operation.

PacketCapturesListResponse

PacketCapturesListResponse: PacketCaptureListResult & object

Contains response data for the list operation.

PcError

PcError: "InternalError" | "AgentStopped" | "CaptureFailed" | "LocalFileFailed" | "StorageFailed"

Defines values for PcError. Possible values include: 'InternalError', 'AgentStopped', 'CaptureFailed', 'LocalFileFailed', 'StorageFailed'

readonly
enum

{string}

PcProtocol

PcProtocol: "TCP" | "UDP" | "Any"

Defines values for PcProtocol. Possible values include: 'TCP', 'UDP', 'Any'

readonly
enum

{string}

PcStatus

PcStatus: "NotStarted" | "Running" | "Stopped" | "Error" | "Unknown"

Defines values for PcStatus. Possible values include: 'NotStarted', 'Running', 'Stopped', 'Error', 'Unknown'

readonly
enum

{string}

PeerExpressRouteCircuitConnectionsGetResponse

PeerExpressRouteCircuitConnectionsGetResponse: PeerExpressRouteCircuitConnection & object

Contains response data for the get operation.

PeerExpressRouteCircuitConnectionsListNextResponse

PeerExpressRouteCircuitConnectionsListNextResponse: PeerExpressRouteCircuitConnectionListResult & object

Contains response data for the listNext operation.

PeerExpressRouteCircuitConnectionsListResponse

PeerExpressRouteCircuitConnectionsListResponse: PeerExpressRouteCircuitConnectionListResult & object

Contains response data for the list operation.

PfsGroup

PfsGroup: "None" | "PFS1" | "PFS2" | "PFS2048" | "ECP256" | "ECP384" | "PFS24" | "PFS14" | "PFSMM"

Defines values for PfsGroup. Possible values include: 'None', 'PFS1', 'PFS2', 'PFS2048', 'ECP256', 'ECP384', 'PFS24', 'PFS14', 'PFSMM'

readonly
enum

{string}

PrivateEndpointsBeginCreateOrUpdateResponse

PrivateEndpointsBeginCreateOrUpdateResponse: PrivateEndpoint & object

Contains response data for the beginCreateOrUpdate operation.

PrivateEndpointsCreateOrUpdateResponse

PrivateEndpointsCreateOrUpdateResponse: PrivateEndpoint & object

Contains response data for the createOrUpdate operation.

PrivateEndpointsGetResponse

PrivateEndpointsGetResponse: PrivateEndpoint & object

Contains response data for the get operation.

PrivateEndpointsListBySubscriptionNextResponse

PrivateEndpointsListBySubscriptionNextResponse: PrivateEndpointListResult & object

Contains response data for the listBySubscriptionNext operation.

PrivateEndpointsListBySubscriptionResponse

PrivateEndpointsListBySubscriptionResponse: PrivateEndpointListResult & object

Contains response data for the listBySubscription operation.

PrivateEndpointsListNextResponse

PrivateEndpointsListNextResponse: PrivateEndpointListResult & object

Contains response data for the listNext operation.

PrivateEndpointsListResponse

PrivateEndpointsListResponse: PrivateEndpointListResult & object

Contains response data for the list operation.

PrivateLinkServicesBeginCreateOrUpdateResponse

PrivateLinkServicesBeginCreateOrUpdateResponse: PrivateLinkService & object

Contains response data for the beginCreateOrUpdate operation.

PrivateLinkServicesCreateOrUpdateResponse

PrivateLinkServicesCreateOrUpdateResponse: PrivateLinkService & object

Contains response data for the createOrUpdate operation.

PrivateLinkServicesGetResponse

PrivateLinkServicesGetResponse: PrivateLinkService & object

Contains response data for the get operation.

PrivateLinkServicesListBySubscriptionNextResponse

PrivateLinkServicesListBySubscriptionNextResponse: PrivateLinkServiceListResult & object

Contains response data for the listBySubscriptionNext operation.

PrivateLinkServicesListBySubscriptionResponse

PrivateLinkServicesListBySubscriptionResponse: PrivateLinkServiceListResult & object

Contains response data for the listBySubscription operation.

PrivateLinkServicesListNextResponse

PrivateLinkServicesListNextResponse: PrivateLinkServiceListResult & object

Contains response data for the listNext operation.

PrivateLinkServicesListResponse

PrivateLinkServicesListResponse: PrivateLinkServiceListResult & object

Contains response data for the list operation.

ProbeProtocol

ProbeProtocol: "Http" | "Tcp" | "Https"

Defines values for ProbeProtocol. Possible values include: 'Http', 'Tcp', 'Https'

readonly
enum

{string}

ProcessorArchitecture

ProcessorArchitecture: "Amd64" | "X86"

Defines values for ProcessorArchitecture. Possible values include: 'Amd64', 'X86'

readonly
enum

{string}

Protocol

Protocol: "Tcp" | "Http" | "Https" | "Icmp"

Defines values for Protocol. Possible values include: 'Tcp', 'Http', 'Https', 'Icmp'

readonly
enum

{string}

ProvisioningState

ProvisioningState: "Succeeded" | "Updating" | "Deleting" | "Failed"

Defines values for ProvisioningState. Possible values include: 'Succeeded', 'Updating', 'Deleting', 'Failed'

readonly
enum

{string}

PublicIPAddressSkuName

PublicIPAddressSkuName: "Basic" | "Standard"

Defines values for PublicIPAddressSkuName. Possible values include: 'Basic', 'Standard'

readonly
enum

{string}

PublicIPAddressesBeginCreateOrUpdateResponse

PublicIPAddressesBeginCreateOrUpdateResponse: PublicIPAddress & object

Contains response data for the beginCreateOrUpdate operation.

PublicIPAddressesBeginUpdateTagsResponse

PublicIPAddressesBeginUpdateTagsResponse: PublicIPAddress & object

Contains response data for the beginUpdateTags operation.

PublicIPAddressesCreateOrUpdateResponse

PublicIPAddressesCreateOrUpdateResponse: PublicIPAddress & object

Contains response data for the createOrUpdate operation.

PublicIPAddressesGetResponse

PublicIPAddressesGetResponse: PublicIPAddress & object

Contains response data for the get operation.

PublicIPAddressesGetVirtualMachineScaleSetPublicIPAddressResponse

PublicIPAddressesGetVirtualMachineScaleSetPublicIPAddressResponse: PublicIPAddress & object

Contains response data for the getVirtualMachineScaleSetPublicIPAddress operation.

PublicIPAddressesListAllNextResponse

PublicIPAddressesListAllNextResponse: PublicIPAddressListResult & object

Contains response data for the listAllNext operation.

PublicIPAddressesListAllResponse

PublicIPAddressesListAllResponse: PublicIPAddressListResult & object

Contains response data for the listAll operation.

PublicIPAddressesListNextResponse

PublicIPAddressesListNextResponse: PublicIPAddressListResult & object

Contains response data for the listNext operation.

PublicIPAddressesListResponse

PublicIPAddressesListResponse: PublicIPAddressListResult & object

Contains response data for the list operation.

PublicIPAddressesListVirtualMachineScaleSetPublicIPAddressesNextResponse

PublicIPAddressesListVirtualMachineScaleSetPublicIPAddressesNextResponse: PublicIPAddressListResult & object

Contains response data for the listVirtualMachineScaleSetPublicIPAddressesNext operation.

PublicIPAddressesListVirtualMachineScaleSetPublicIPAddressesResponse

PublicIPAddressesListVirtualMachineScaleSetPublicIPAddressesResponse: PublicIPAddressListResult & object

Contains response data for the listVirtualMachineScaleSetPublicIPAddresses operation.

PublicIPAddressesListVirtualMachineScaleSetVMPublicIPAddressesNextResponse

PublicIPAddressesListVirtualMachineScaleSetVMPublicIPAddressesNextResponse: PublicIPAddressListResult & object

Contains response data for the listVirtualMachineScaleSetVMPublicIPAddressesNext operation.

PublicIPAddressesListVirtualMachineScaleSetVMPublicIPAddressesResponse

PublicIPAddressesListVirtualMachineScaleSetVMPublicIPAddressesResponse: PublicIPAddressListResult & object

Contains response data for the listVirtualMachineScaleSetVMPublicIPAddresses operation.

PublicIPAddressesUpdateTagsResponse

PublicIPAddressesUpdateTagsResponse: PublicIPAddress & object

Contains response data for the updateTags operation.

PublicIPPrefixSkuName

PublicIPPrefixSkuName: "Standard"

Defines values for PublicIPPrefixSkuName. Possible values include: 'Standard'

readonly
enum

{string}

PublicIPPrefixesBeginCreateOrUpdateResponse

PublicIPPrefixesBeginCreateOrUpdateResponse: PublicIPPrefix & object

Contains response data for the beginCreateOrUpdate operation.

PublicIPPrefixesBeginUpdateTagsResponse

PublicIPPrefixesBeginUpdateTagsResponse: PublicIPPrefix & object

Contains response data for the beginUpdateTags operation.

PublicIPPrefixesCreateOrUpdateResponse

PublicIPPrefixesCreateOrUpdateResponse: PublicIPPrefix & object

Contains response data for the createOrUpdate operation.

PublicIPPrefixesGetResponse

PublicIPPrefixesGetResponse: PublicIPPrefix & object

Contains response data for the get operation.

PublicIPPrefixesListAllNextResponse

PublicIPPrefixesListAllNextResponse: PublicIPPrefixListResult & object

Contains response data for the listAllNext operation.

PublicIPPrefixesListAllResponse

PublicIPPrefixesListAllResponse: PublicIPPrefixListResult & object

Contains response data for the listAll operation.

PublicIPPrefixesListNextResponse

PublicIPPrefixesListNextResponse: PublicIPPrefixListResult & object

Contains response data for the listNext operation.

PublicIPPrefixesListResponse

PublicIPPrefixesListResponse: PublicIPPrefixListResult & object

Contains response data for the list operation.

PublicIPPrefixesUpdateTagsResponse

PublicIPPrefixesUpdateTagsResponse: PublicIPPrefix & object

Contains response data for the updateTags operation.

ResourceIdentityType

ResourceIdentityType: "SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None"

Defines values for ResourceIdentityType. Possible values include: 'SystemAssigned', 'UserAssigned', 'SystemAssigned, UserAssigned', 'None'

readonly
enum

{string}

ResourceNavigationLinksListResponse

ResourceNavigationLinksListResponse: ResourceNavigationLinksListResult & object

Contains response data for the list operation.

RouteFilterRulesBeginCreateOrUpdateResponse

RouteFilterRulesBeginCreateOrUpdateResponse: RouteFilterRule & object

Contains response data for the beginCreateOrUpdate operation.

RouteFilterRulesBeginUpdateResponse

RouteFilterRulesBeginUpdateResponse: RouteFilterRule & object

Contains response data for the beginUpdate operation.

RouteFilterRulesCreateOrUpdateResponse

RouteFilterRulesCreateOrUpdateResponse: RouteFilterRule & object

Contains response data for the createOrUpdate operation.

RouteFilterRulesGetResponse

RouteFilterRulesGetResponse: RouteFilterRule & object

Contains response data for the get operation.

RouteFilterRulesListByRouteFilterNextResponse

RouteFilterRulesListByRouteFilterNextResponse: RouteFilterRuleListResult & object

Contains response data for the listByRouteFilterNext operation.

RouteFilterRulesListByRouteFilterResponse

RouteFilterRulesListByRouteFilterResponse: RouteFilterRuleListResult & object

Contains response data for the listByRouteFilter operation.

RouteFilterRulesUpdateResponse

RouteFilterRulesUpdateResponse: RouteFilterRule & object

Contains response data for the update operation.

RouteFiltersBeginCreateOrUpdateResponse

RouteFiltersBeginCreateOrUpdateResponse: RouteFilter & object

Contains response data for the beginCreateOrUpdate operation.

RouteFiltersBeginUpdateResponse

RouteFiltersBeginUpdateResponse: RouteFilter & object

Contains response data for the beginUpdate operation.

RouteFiltersCreateOrUpdateResponse

RouteFiltersCreateOrUpdateResponse: RouteFilter & object

Contains response data for the createOrUpdate operation.

RouteFiltersGetResponse

RouteFiltersGetResponse: RouteFilter & object

Contains response data for the get operation.

RouteFiltersListByResourceGroupNextResponse

RouteFiltersListByResourceGroupNextResponse: RouteFilterListResult & object

Contains response data for the listByResourceGroupNext operation.

RouteFiltersListByResourceGroupResponse

RouteFiltersListByResourceGroupResponse: RouteFilterListResult & object

Contains response data for the listByResourceGroup operation.

RouteFiltersListNextResponse

RouteFiltersListNextResponse: RouteFilterListResult & object

Contains response data for the listNext operation.

RouteFiltersListResponse

RouteFiltersListResponse: RouteFilterListResult & object

Contains response data for the list operation.

RouteFiltersUpdateResponse

RouteFiltersUpdateResponse: RouteFilter & object

Contains response data for the update operation.

RouteNextHopType

RouteNextHopType: "VirtualNetworkGateway" | "VnetLocal" | "Internet" | "VirtualAppliance" | "None"

Defines values for RouteNextHopType. Possible values include: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', 'None'

readonly
enum

{string}

RouteTablesBeginCreateOrUpdateResponse

RouteTablesBeginCreateOrUpdateResponse: RouteTable & object

Contains response data for the beginCreateOrUpdate operation.

RouteTablesBeginUpdateTagsResponse

RouteTablesBeginUpdateTagsResponse: RouteTable & object

Contains response data for the beginUpdateTags operation.

RouteTablesCreateOrUpdateResponse

RouteTablesCreateOrUpdateResponse: RouteTable & object

Contains response data for the createOrUpdate operation.

RouteTablesGetResponse

RouteTablesGetResponse: RouteTable & object

Contains response data for the get operation.

RouteTablesListAllNextResponse

RouteTablesListAllNextResponse: RouteTableListResult & object

Contains response data for the listAllNext operation.

RouteTablesListAllResponse

RouteTablesListAllResponse: RouteTableListResult & object

Contains response data for the listAll operation.

RouteTablesListNextResponse

RouteTablesListNextResponse: RouteTableListResult & object

Contains response data for the listNext operation.

RouteTablesListResponse

RouteTablesListResponse: RouteTableListResult & object

Contains response data for the list operation.

RouteTablesUpdateTagsResponse

RouteTablesUpdateTagsResponse: RouteTable & object

Contains response data for the updateTags operation.

RoutesBeginCreateOrUpdateResponse

RoutesBeginCreateOrUpdateResponse: Route & object

Contains response data for the beginCreateOrUpdate operation.

RoutesCreateOrUpdateResponse

RoutesCreateOrUpdateResponse: Route & object

Contains response data for the createOrUpdate operation.

RoutesGetResponse

RoutesGetResponse: Route & object

Contains response data for the get operation.

RoutesListNextResponse

RoutesListNextResponse: RouteListResult & object

Contains response data for the listNext operation.

RoutesListResponse

RoutesListResponse: RouteListResult & object

Contains response data for the list operation.

SecurityRuleAccess

SecurityRuleAccess: "Allow" | "Deny"

Defines values for SecurityRuleAccess. Possible values include: 'Allow', 'Deny'

readonly
enum

{string}

SecurityRuleDirection

SecurityRuleDirection: "Inbound" | "Outbound"

Defines values for SecurityRuleDirection. Possible values include: 'Inbound', 'Outbound'

readonly
enum

{string}

SecurityRuleProtocol

SecurityRuleProtocol: "Tcp" | "Udp" | "Icmp" | "Esp" | "*"

Defines values for SecurityRuleProtocol. Possible values include: 'Tcp', 'Udp', 'Icmp', 'Esp', '*'

readonly
enum

{string}

SecurityRulesBeginCreateOrUpdateResponse

SecurityRulesBeginCreateOrUpdateResponse: SecurityRule & object

Contains response data for the beginCreateOrUpdate operation.

SecurityRulesCreateOrUpdateResponse

SecurityRulesCreateOrUpdateResponse: SecurityRule & object

Contains response data for the createOrUpdate operation.

SecurityRulesGetResponse

SecurityRulesGetResponse: SecurityRule & object

Contains response data for the get operation.

SecurityRulesListNextResponse

SecurityRulesListNextResponse: SecurityRuleListResult & object

Contains response data for the listNext operation.

SecurityRulesListResponse

SecurityRulesListResponse: SecurityRuleListResult & object

Contains response data for the list operation.

ServiceAssociationLinksListResponse

ServiceAssociationLinksListResponse: ServiceAssociationLinksListResult & object

Contains response data for the list operation.

ServiceEndpointPoliciesBeginCreateOrUpdateResponse

ServiceEndpointPoliciesBeginCreateOrUpdateResponse: ServiceEndpointPolicy & object

Contains response data for the beginCreateOrUpdate operation.

ServiceEndpointPoliciesBeginUpdateResponse

ServiceEndpointPoliciesBeginUpdateResponse: ServiceEndpointPolicy & object

Contains response data for the beginUpdate operation.

ServiceEndpointPoliciesCreateOrUpdateResponse

ServiceEndpointPoliciesCreateOrUpdateResponse: ServiceEndpointPolicy & object

Contains response data for the createOrUpdate operation.

ServiceEndpointPoliciesGetResponse

ServiceEndpointPoliciesGetResponse: ServiceEndpointPolicy & object

Contains response data for the get operation.

ServiceEndpointPoliciesListByResourceGroupNextResponse

ServiceEndpointPoliciesListByResourceGroupNextResponse: ServiceEndpointPolicyListResult & object

Contains response data for the listByResourceGroupNext operation.

ServiceEndpointPoliciesListByResourceGroupResponse

ServiceEndpointPoliciesListByResourceGroupResponse: ServiceEndpointPolicyListResult & object

Contains response data for the listByResourceGroup operation.

ServiceEndpointPoliciesListNextResponse

ServiceEndpointPoliciesListNextResponse: ServiceEndpointPolicyListResult & object

Contains response data for the listNext operation.

ServiceEndpointPoliciesListResponse

ServiceEndpointPoliciesListResponse: ServiceEndpointPolicyListResult & object

Contains response data for the list operation.

ServiceEndpointPoliciesUpdateResponse

ServiceEndpointPoliciesUpdateResponse: ServiceEndpointPolicy & object

Contains response data for the update operation.

ServiceEndpointPolicyDefinitionsBeginCreateOrUpdateResponse

ServiceEndpointPolicyDefinitionsBeginCreateOrUpdateResponse: ServiceEndpointPolicyDefinition & object

Contains response data for the beginCreateOrUpdate operation.

ServiceEndpointPolicyDefinitionsCreateOrUpdateResponse

ServiceEndpointPolicyDefinitionsCreateOrUpdateResponse: ServiceEndpointPolicyDefinition & object

Contains response data for the createOrUpdate operation.

ServiceEndpointPolicyDefinitionsGetResponse

ServiceEndpointPolicyDefinitionsGetResponse: ServiceEndpointPolicyDefinition & object

Contains response data for the get operation.

ServiceEndpointPolicyDefinitionsListByResourceGroupNextResponse

ServiceEndpointPolicyDefinitionsListByResourceGroupNextResponse: ServiceEndpointPolicyDefinitionListResult & object

Contains response data for the listByResourceGroupNext operation.

ServiceEndpointPolicyDefinitionsListByResourceGroupResponse

ServiceEndpointPolicyDefinitionsListByResourceGroupResponse: ServiceEndpointPolicyDefinitionListResult & object

Contains response data for the listByResourceGroup operation.

ServiceProviderProvisioningState

ServiceProviderProvisioningState: "NotProvisioned" | "Provisioning" | "Provisioned" | "Deprovisioning"

Defines values for ServiceProviderProvisioningState. Possible values include: 'NotProvisioned', 'Provisioning', 'Provisioned', 'Deprovisioning'

readonly
enum

{string}

ServiceTagsListResponse

ServiceTagsListResponse: ServiceTagsListResult & object

Contains response data for the list operation.

Severity

Severity: "Error" | "Warning"

Defines values for Severity. Possible values include: 'Error', 'Warning'

readonly
enum

{string}

SubnetsBeginCreateOrUpdateResponse

SubnetsBeginCreateOrUpdateResponse: Subnet & object

Contains response data for the beginCreateOrUpdate operation.

SubnetsCreateOrUpdateResponse

SubnetsCreateOrUpdateResponse: Subnet & object

Contains response data for the createOrUpdate operation.

SubnetsGetResponse

SubnetsGetResponse: Subnet & object

Contains response data for the get operation.

SubnetsListNextResponse

SubnetsListNextResponse: SubnetListResult & object

Contains response data for the listNext operation.

SubnetsListResponse

SubnetsListResponse: SubnetListResult & object

Contains response data for the list operation.

SupportedSecurityProvidersResponse

SupportedSecurityProvidersResponse: VirtualWanSecurityProviders & object

Contains response data for the supportedSecurityProviders operation.

TransportProtocol

TransportProtocol: "Udp" | "Tcp" | "All"

Defines values for TransportProtocol. Possible values include: 'Udp', 'Tcp', 'All'

readonly
enum

{string}

TunnelConnectionStatus

TunnelConnectionStatus: "Unknown" | "Connecting" | "Connected" | "NotConnected"

Defines values for TunnelConnectionStatus. Possible values include: 'Unknown', 'Connecting', 'Connected', 'NotConnected'

readonly
enum

{string}

UsagesListNextResponse

UsagesListNextResponse: UsagesListResult & object

Contains response data for the listNext operation.

UsagesListResponse

UsagesListResponse: UsagesListResult & object

Contains response data for the list operation.

VerbosityLevel

VerbosityLevel: "Normal" | "Minimum" | "Full"

Defines values for VerbosityLevel. Possible values include: 'Normal', 'Minimum', 'Full'

readonly
enum

{string}

VirtualHubsBeginCreateOrUpdateResponse

VirtualHubsBeginCreateOrUpdateResponse: VirtualHub & object

Contains response data for the beginCreateOrUpdate operation.

VirtualHubsBeginUpdateTagsResponse

VirtualHubsBeginUpdateTagsResponse: VirtualHub & object

Contains response data for the beginUpdateTags operation.

VirtualHubsCreateOrUpdateResponse

VirtualHubsCreateOrUpdateResponse: VirtualHub & object

Contains response data for the createOrUpdate operation.

VirtualHubsGetResponse

VirtualHubsGetResponse: VirtualHub & object

Contains response data for the get operation.

VirtualHubsListByResourceGroupNextResponse

VirtualHubsListByResourceGroupNextResponse: ListVirtualHubsResult & object

Contains response data for the listByResourceGroupNext operation.

VirtualHubsListByResourceGroupResponse

VirtualHubsListByResourceGroupResponse: ListVirtualHubsResult & object

Contains response data for the listByResourceGroup operation.

VirtualHubsListNextResponse

VirtualHubsListNextResponse: ListVirtualHubsResult & object

Contains response data for the listNext operation.

VirtualHubsListResponse

VirtualHubsListResponse: ListVirtualHubsResult & object

Contains response data for the list operation.

VirtualHubsUpdateTagsResponse

VirtualHubsUpdateTagsResponse: VirtualHub & object

Contains response data for the updateTags operation.

VirtualNetworkGatewayConnectionProtocol

VirtualNetworkGatewayConnectionProtocol: "IKEv2" | "IKEv1"

Defines values for VirtualNetworkGatewayConnectionProtocol. Possible values include: 'IKEv2', 'IKEv1'

readonly
enum

{string}

VirtualNetworkGatewayConnectionStatus

VirtualNetworkGatewayConnectionStatus: "Unknown" | "Connecting" | "Connected" | "NotConnected"

Defines values for VirtualNetworkGatewayConnectionStatus. Possible values include: 'Unknown', 'Connecting', 'Connected', 'NotConnected'

readonly
enum

{string}

VirtualNetworkGatewayConnectionType

VirtualNetworkGatewayConnectionType: "IPsec" | "Vnet2Vnet" | "ExpressRoute" | "VPNClient"

Defines values for VirtualNetworkGatewayConnectionType. Possible values include: 'IPsec', 'Vnet2Vnet', 'ExpressRoute', 'VPNClient'

readonly
enum

{string}

VirtualNetworkGatewayConnectionsBeginCreateOrUpdateResponse

VirtualNetworkGatewayConnectionsBeginCreateOrUpdateResponse: VirtualNetworkGatewayConnection & object

Contains response data for the beginCreateOrUpdate operation.

VirtualNetworkGatewayConnectionsBeginResetSharedKeyResponse

VirtualNetworkGatewayConnectionsBeginResetSharedKeyResponse: ConnectionResetSharedKey & object

Contains response data for the beginResetSharedKey operation.

VirtualNetworkGatewayConnectionsBeginSetSharedKeyResponse

VirtualNetworkGatewayConnectionsBeginSetSharedKeyResponse: ConnectionSharedKey & object

Contains response data for the beginSetSharedKey operation.

VirtualNetworkGatewayConnectionsBeginUpdateTagsResponse

VirtualNetworkGatewayConnectionsBeginUpdateTagsResponse: VirtualNetworkGatewayConnection & object

Contains response data for the beginUpdateTags operation.

VirtualNetworkGatewayConnectionsCreateOrUpdateResponse

VirtualNetworkGatewayConnectionsCreateOrUpdateResponse: VirtualNetworkGatewayConnection & object

Contains response data for the createOrUpdate operation.

VirtualNetworkGatewayConnectionsGetResponse

VirtualNetworkGatewayConnectionsGetResponse: VirtualNetworkGatewayConnection & object

Contains response data for the get operation.

VirtualNetworkGatewayConnectionsGetSharedKeyResponse

VirtualNetworkGatewayConnectionsGetSharedKeyResponse: ConnectionSharedKey & object

Contains response data for the getSharedKey operation.

VirtualNetworkGatewayConnectionsListNextResponse

VirtualNetworkGatewayConnectionsListNextResponse: VirtualNetworkGatewayConnectionListResult & object

Contains response data for the listNext operation.

VirtualNetworkGatewayConnectionsListResponse

VirtualNetworkGatewayConnectionsListResponse: VirtualNetworkGatewayConnectionListResult & object

Contains response data for the list operation.

VirtualNetworkGatewayConnectionsResetSharedKeyResponse

VirtualNetworkGatewayConnectionsResetSharedKeyResponse: ConnectionResetSharedKey & object

Contains response data for the resetSharedKey operation.

VirtualNetworkGatewayConnectionsSetSharedKeyResponse

VirtualNetworkGatewayConnectionsSetSharedKeyResponse: ConnectionSharedKey & object

Contains response data for the setSharedKey operation.

VirtualNetworkGatewayConnectionsUpdateTagsResponse

VirtualNetworkGatewayConnectionsUpdateTagsResponse: VirtualNetworkGatewayConnection & object

Contains response data for the updateTags operation.

VirtualNetworkGatewaySkuName

VirtualNetworkGatewaySkuName: "Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3" | "VpnGw1AZ" | "VpnGw2AZ" | "VpnGw3AZ" | "ErGw1AZ" | "ErGw2AZ" | "ErGw3AZ"

Defines values for VirtualNetworkGatewaySkuName. Possible values include: 'Basic', 'HighPerformance', 'Standard', 'UltraPerformance', 'VpnGw1', 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', 'VpnGw3AZ', 'ErGw1AZ', 'ErGw2AZ', 'ErGw3AZ'

readonly
enum

{string}

VirtualNetworkGatewaySkuTier

VirtualNetworkGatewaySkuTier: "Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3" | "VpnGw1AZ" | "VpnGw2AZ" | "VpnGw3AZ" | "ErGw1AZ" | "ErGw2AZ" | "ErGw3AZ"

Defines values for VirtualNetworkGatewaySkuTier. Possible values include: 'Basic', 'HighPerformance', 'Standard', 'UltraPerformance', 'VpnGw1', 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', 'VpnGw3AZ', 'ErGw1AZ', 'ErGw2AZ', 'ErGw3AZ'

readonly
enum

{string}

VirtualNetworkGatewayType

VirtualNetworkGatewayType: "Vpn" | "ExpressRoute"

Defines values for VirtualNetworkGatewayType. Possible values include: 'Vpn', 'ExpressRoute'

readonly
enum

{string}

VirtualNetworkGatewaysBeginCreateOrUpdateResponse

VirtualNetworkGatewaysBeginCreateOrUpdateResponse: VirtualNetworkGateway & object

Contains response data for the beginCreateOrUpdate operation.

VirtualNetworkGatewaysBeginGetAdvertisedRoutesResponse

VirtualNetworkGatewaysBeginGetAdvertisedRoutesResponse: GatewayRouteListResult & object

Contains response data for the beginGetAdvertisedRoutes operation.

VirtualNetworkGatewaysBeginGetBgpPeerStatusResponse

VirtualNetworkGatewaysBeginGetBgpPeerStatusResponse: BgpPeerStatusListResult & object

Contains response data for the beginGetBgpPeerStatus operation.

VirtualNetworkGatewaysBeginGetLearnedRoutesResponse

VirtualNetworkGatewaysBeginGetLearnedRoutesResponse: GatewayRouteListResult & object

Contains response data for the beginGetLearnedRoutes operation.

VirtualNetworkGatewaysBeginGetVpnProfilePackageUrlResponse

VirtualNetworkGatewaysBeginGetVpnProfilePackageUrlResponse: object

Contains response data for the beginGetVpnProfilePackageUrl operation.

Type declaration

VirtualNetworkGatewaysBeginGetVpnclientConnectionHealthResponse

VirtualNetworkGatewaysBeginGetVpnclientConnectionHealthResponse: VpnClientConnectionHealthDetailListResult & object

Contains response data for the beginGetVpnclientConnectionHealth operation.

VirtualNetworkGatewaysBeginGetVpnclientIpsecParametersResponse

VirtualNetworkGatewaysBeginGetVpnclientIpsecParametersResponse: VpnClientIPsecParameters & object

Contains response data for the beginGetVpnclientIpsecParameters operation.

VirtualNetworkGatewaysBeginResetResponse

VirtualNetworkGatewaysBeginResetResponse: VirtualNetworkGateway & object

Contains response data for the beginReset operation.

VirtualNetworkGatewaysBeginSetVpnclientIpsecParametersResponse

VirtualNetworkGatewaysBeginSetVpnclientIpsecParametersResponse: VpnClientIPsecParameters & object

Contains response data for the beginSetVpnclientIpsecParameters operation.

VirtualNetworkGatewaysBeginUpdateTagsResponse

VirtualNetworkGatewaysBeginUpdateTagsResponse: VirtualNetworkGateway & object

Contains response data for the beginUpdateTags operation.

VirtualNetworkGatewaysCreateOrUpdateResponse

VirtualNetworkGatewaysCreateOrUpdateResponse: VirtualNetworkGateway & object

Contains response data for the createOrUpdate operation.

VirtualNetworkGatewaysGenerateVpnProfileResponse

VirtualNetworkGatewaysGenerateVpnProfileResponse: object

Contains response data for the generateVpnProfile operation.

Type declaration

VirtualNetworkGatewaysGeneratevpnclientpackageResponse

VirtualNetworkGatewaysGeneratevpnclientpackageResponse: object

Contains response data for the generatevpnclientpackage operation.

Type declaration

VirtualNetworkGatewaysGetAdvertisedRoutesResponse

VirtualNetworkGatewaysGetAdvertisedRoutesResponse: GatewayRouteListResult & object

Contains response data for the getAdvertisedRoutes operation.

VirtualNetworkGatewaysGetBgpPeerStatusResponse

VirtualNetworkGatewaysGetBgpPeerStatusResponse: BgpPeerStatusListResult & object

Contains response data for the getBgpPeerStatus operation.

VirtualNetworkGatewaysGetLearnedRoutesResponse

VirtualNetworkGatewaysGetLearnedRoutesResponse: GatewayRouteListResult & object

Contains response data for the getLearnedRoutes operation.

VirtualNetworkGatewaysGetResponse

VirtualNetworkGatewaysGetResponse: VirtualNetworkGateway & object

Contains response data for the get operation.

VirtualNetworkGatewaysGetVpnProfilePackageUrlResponse

VirtualNetworkGatewaysGetVpnProfilePackageUrlResponse: object

Contains response data for the getVpnProfilePackageUrl operation.

Type declaration

VirtualNetworkGatewaysGetVpnclientConnectionHealthResponse

VirtualNetworkGatewaysGetVpnclientConnectionHealthResponse: VpnClientConnectionHealthDetailListResult & object

Contains response data for the getVpnclientConnectionHealth operation.

VirtualNetworkGatewaysGetVpnclientIpsecParametersResponse

VirtualNetworkGatewaysGetVpnclientIpsecParametersResponse: VpnClientIPsecParameters & object

Contains response data for the getVpnclientIpsecParameters operation.

VirtualNetworkGatewaysListConnectionsNextResponse

VirtualNetworkGatewaysListConnectionsNextResponse: VirtualNetworkGatewayListConnectionsResult & object

Contains response data for the listConnectionsNext operation.

VirtualNetworkGatewaysListConnectionsResponse

VirtualNetworkGatewaysListConnectionsResponse: VirtualNetworkGatewayListConnectionsResult & object

Contains response data for the listConnections operation.

VirtualNetworkGatewaysListNextResponse

VirtualNetworkGatewaysListNextResponse: VirtualNetworkGatewayListResult & object

Contains response data for the listNext operation.

VirtualNetworkGatewaysListResponse

VirtualNetworkGatewaysListResponse: VirtualNetworkGatewayListResult & object

Contains response data for the list operation.

VirtualNetworkGatewaysResetResponse

VirtualNetworkGatewaysResetResponse: VirtualNetworkGateway & object

Contains response data for the reset operation.

VirtualNetworkGatewaysSetVpnclientIpsecParametersResponse

VirtualNetworkGatewaysSetVpnclientIpsecParametersResponse: VpnClientIPsecParameters & object

Contains response data for the setVpnclientIpsecParameters operation.

VirtualNetworkGatewaysSupportedVpnDevicesResponse

VirtualNetworkGatewaysSupportedVpnDevicesResponse: object

Contains response data for the supportedVpnDevices operation.

Type declaration

VirtualNetworkGatewaysUpdateTagsResponse

VirtualNetworkGatewaysUpdateTagsResponse: VirtualNetworkGateway & object

Contains response data for the updateTags operation.

VirtualNetworkGatewaysVpnDeviceConfigurationScriptResponse

VirtualNetworkGatewaysVpnDeviceConfigurationScriptResponse: object

Contains response data for the vpnDeviceConfigurationScript operation.

Type declaration

VirtualNetworkPeeringState

VirtualNetworkPeeringState: "Initiated" | "Connected" | "Disconnected"

Defines values for VirtualNetworkPeeringState. Possible values include: 'Initiated', 'Connected', 'Disconnected'

readonly
enum

{string}

VirtualNetworkPeeringsBeginCreateOrUpdateResponse

VirtualNetworkPeeringsBeginCreateOrUpdateResponse: VirtualNetworkPeering & object

Contains response data for the beginCreateOrUpdate operation.

VirtualNetworkPeeringsCreateOrUpdateResponse

VirtualNetworkPeeringsCreateOrUpdateResponse: VirtualNetworkPeering & object

Contains response data for the createOrUpdate operation.

VirtualNetworkPeeringsGetResponse

VirtualNetworkPeeringsGetResponse: VirtualNetworkPeering & object

Contains response data for the get operation.

VirtualNetworkPeeringsListNextResponse

VirtualNetworkPeeringsListNextResponse: VirtualNetworkPeeringListResult & object

Contains response data for the listNext operation.

VirtualNetworkPeeringsListResponse

VirtualNetworkPeeringsListResponse: VirtualNetworkPeeringListResult & object

Contains response data for the list operation.

VirtualNetworkTapsBeginCreateOrUpdateResponse

VirtualNetworkTapsBeginCreateOrUpdateResponse: VirtualNetworkTap & object

Contains response data for the beginCreateOrUpdate operation.

VirtualNetworkTapsBeginUpdateTagsResponse

VirtualNetworkTapsBeginUpdateTagsResponse: VirtualNetworkTap & object

Contains response data for the beginUpdateTags operation.

VirtualNetworkTapsCreateOrUpdateResponse

VirtualNetworkTapsCreateOrUpdateResponse: VirtualNetworkTap & object

Contains response data for the createOrUpdate operation.

VirtualNetworkTapsGetResponse

VirtualNetworkTapsGetResponse: VirtualNetworkTap & object

Contains response data for the get operation.

VirtualNetworkTapsListAllNextResponse

VirtualNetworkTapsListAllNextResponse: VirtualNetworkTapListResult & object

Contains response data for the listAllNext operation.

VirtualNetworkTapsListAllResponse

VirtualNetworkTapsListAllResponse: VirtualNetworkTapListResult & object

Contains response data for the listAll operation.

VirtualNetworkTapsListByResourceGroupNextResponse

VirtualNetworkTapsListByResourceGroupNextResponse: VirtualNetworkTapListResult & object

Contains response data for the listByResourceGroupNext operation.

VirtualNetworkTapsListByResourceGroupResponse

VirtualNetworkTapsListByResourceGroupResponse: VirtualNetworkTapListResult & object

Contains response data for the listByResourceGroup operation.

VirtualNetworkTapsUpdateTagsResponse

VirtualNetworkTapsUpdateTagsResponse: VirtualNetworkTap & object

Contains response data for the updateTags operation.

VirtualNetworksBeginCreateOrUpdateResponse

VirtualNetworksBeginCreateOrUpdateResponse: VirtualNetwork & object

Contains response data for the beginCreateOrUpdate operation.

VirtualNetworksBeginUpdateTagsResponse

VirtualNetworksBeginUpdateTagsResponse: VirtualNetwork & object

Contains response data for the beginUpdateTags operation.

VirtualNetworksCheckIPAddressAvailabilityResponse

VirtualNetworksCheckIPAddressAvailabilityResponse: IPAddressAvailabilityResult & object

Contains response data for the checkIPAddressAvailability operation.

VirtualNetworksCreateOrUpdateResponse

VirtualNetworksCreateOrUpdateResponse: VirtualNetwork & object

Contains response data for the createOrUpdate operation.

VirtualNetworksGetResponse

VirtualNetworksGetResponse: VirtualNetwork & object

Contains response data for the get operation.

VirtualNetworksListAllNextResponse

VirtualNetworksListAllNextResponse: VirtualNetworkListResult & object

Contains response data for the listAllNext operation.

VirtualNetworksListAllResponse

VirtualNetworksListAllResponse: VirtualNetworkListResult & object

Contains response data for the listAll operation.

VirtualNetworksListNextResponse

VirtualNetworksListNextResponse: VirtualNetworkListResult & object

Contains response data for the listNext operation.

VirtualNetworksListResponse

VirtualNetworksListResponse: VirtualNetworkListResult & object

Contains response data for the list operation.

VirtualNetworksListUsageNextResponse

VirtualNetworksListUsageNextResponse: VirtualNetworkListUsageResult & object

Contains response data for the listUsageNext operation.

VirtualNetworksListUsageResponse

VirtualNetworksListUsageResponse: VirtualNetworkListUsageResult & object

Contains response data for the listUsage operation.

VirtualNetworksUpdateTagsResponse

VirtualNetworksUpdateTagsResponse: VirtualNetwork & object

Contains response data for the updateTags operation.

VirtualWanSecurityProviderType

VirtualWanSecurityProviderType: "External" | "Native"

Defines values for VirtualWanSecurityProviderType. Possible values include: 'External', 'Native'

readonly
enum

{string}

VirtualWansBeginCreateOrUpdateResponse

VirtualWansBeginCreateOrUpdateResponse: VirtualWAN & object

Contains response data for the beginCreateOrUpdate operation.

VirtualWansBeginUpdateTagsResponse

VirtualWansBeginUpdateTagsResponse: VirtualWAN & object

Contains response data for the beginUpdateTags operation.

VirtualWansCreateOrUpdateResponse

VirtualWansCreateOrUpdateResponse: VirtualWAN & object

Contains response data for the createOrUpdate operation.

VirtualWansGetResponse

VirtualWansGetResponse: VirtualWAN & object

Contains response data for the get operation.

VirtualWansListByResourceGroupNextResponse

VirtualWansListByResourceGroupNextResponse: ListVirtualWANsResult & object

Contains response data for the listByResourceGroupNext operation.

VirtualWansListByResourceGroupResponse

VirtualWansListByResourceGroupResponse: ListVirtualWANsResult & object

Contains response data for the listByResourceGroup operation.

VirtualWansListNextResponse

VirtualWansListNextResponse: ListVirtualWANsResult & object

Contains response data for the listNext operation.

VirtualWansListResponse

VirtualWansListResponse: ListVirtualWANsResult & object

Contains response data for the list operation.

VirtualWansUpdateTagsResponse

VirtualWansUpdateTagsResponse: VirtualWAN & object

Contains response data for the updateTags operation.

VpnClientProtocol

VpnClientProtocol: "IkeV2" | "SSTP" | "OpenVPN"

Defines values for VpnClientProtocol. Possible values include: 'IkeV2', 'SSTP', 'OpenVPN'

readonly
enum

{string}

VpnConnectionStatus

VpnConnectionStatus: "Unknown" | "Connecting" | "Connected" | "NotConnected"

Defines values for VpnConnectionStatus. Possible values include: 'Unknown', 'Connecting', 'Connected', 'NotConnected'

readonly
enum

{string}

VpnConnectionsBeginCreateOrUpdateResponse

VpnConnectionsBeginCreateOrUpdateResponse: VpnConnection & object

Contains response data for the beginCreateOrUpdate operation.

VpnConnectionsCreateOrUpdateResponse

VpnConnectionsCreateOrUpdateResponse: VpnConnection & object

Contains response data for the createOrUpdate operation.

VpnConnectionsGetResponse

VpnConnectionsGetResponse: VpnConnection & object

Contains response data for the get operation.

VpnConnectionsListByVpnGatewayNextResponse

VpnConnectionsListByVpnGatewayNextResponse: ListVpnConnectionsResult & object

Contains response data for the listByVpnGatewayNext operation.

VpnConnectionsListByVpnGatewayResponse

VpnConnectionsListByVpnGatewayResponse: ListVpnConnectionsResult & object

Contains response data for the listByVpnGateway operation.

VpnGatewayTunnelingProtocol

VpnGatewayTunnelingProtocol: "IkeV2" | "OpenVPN"

Defines values for VpnGatewayTunnelingProtocol. Possible values include: 'IkeV2', 'OpenVPN'

readonly
enum

{string}

VpnGatewaysBeginCreateOrUpdateResponse

VpnGatewaysBeginCreateOrUpdateResponse: VpnGateway & object

Contains response data for the beginCreateOrUpdate operation.

VpnGatewaysBeginResetResponse

VpnGatewaysBeginResetResponse: VpnGateway & object

Contains response data for the beginReset operation.

VpnGatewaysBeginUpdateTagsResponse

VpnGatewaysBeginUpdateTagsResponse: VpnGateway & object

Contains response data for the beginUpdateTags operation.

VpnGatewaysCreateOrUpdateResponse

VpnGatewaysCreateOrUpdateResponse: VpnGateway & object

Contains response data for the createOrUpdate operation.

VpnGatewaysGetResponse

VpnGatewaysGetResponse: VpnGateway & object

Contains response data for the get operation.

VpnGatewaysListByResourceGroupNextResponse

VpnGatewaysListByResourceGroupNextResponse: ListVpnGatewaysResult & object

Contains response data for the listByResourceGroupNext operation.

VpnGatewaysListByResourceGroupResponse

VpnGatewaysListByResourceGroupResponse: ListVpnGatewaysResult & object

Contains response data for the listByResourceGroup operation.

VpnGatewaysListNextResponse

VpnGatewaysListNextResponse: ListVpnGatewaysResult & object

Contains response data for the listNext operation.

VpnGatewaysListResponse

VpnGatewaysListResponse: ListVpnGatewaysResult & object

Contains response data for the list operation.

VpnGatewaysResetResponse

VpnGatewaysResetResponse: VpnGateway & object

Contains response data for the reset operation.

VpnGatewaysUpdateTagsResponse

VpnGatewaysUpdateTagsResponse: VpnGateway & object

Contains response data for the updateTags operation.

VpnSitesBeginCreateOrUpdateResponse

VpnSitesBeginCreateOrUpdateResponse: VpnSite & object

Contains response data for the beginCreateOrUpdate operation.

VpnSitesBeginUpdateTagsResponse

VpnSitesBeginUpdateTagsResponse: VpnSite & object

Contains response data for the beginUpdateTags operation.

VpnSitesCreateOrUpdateResponse

VpnSitesCreateOrUpdateResponse: VpnSite & object

Contains response data for the createOrUpdate operation.

VpnSitesGetResponse

VpnSitesGetResponse: VpnSite & object

Contains response data for the get operation.

VpnSitesListByResourceGroupNextResponse

VpnSitesListByResourceGroupNextResponse: ListVpnSitesResult & object

Contains response data for the listByResourceGroupNext operation.

VpnSitesListByResourceGroupResponse

VpnSitesListByResourceGroupResponse: ListVpnSitesResult & object

Contains response data for the listByResourceGroup operation.

VpnSitesListNextResponse

VpnSitesListNextResponse: ListVpnSitesResult & object

Contains response data for the listNext operation.

VpnSitesListResponse

VpnSitesListResponse: ListVpnSitesResult & object

Contains response data for the list operation.

VpnSitesUpdateTagsResponse

VpnSitesUpdateTagsResponse: VpnSite & object

Contains response data for the updateTags operation.

VpnType

VpnType: "PolicyBased" | "RouteBased"

Defines values for VpnType. Possible values include: 'PolicyBased', 'RouteBased'

readonly
enum

{string}

WebApplicationFirewallAction

WebApplicationFirewallAction: "Allow" | "Block" | "Log"

Defines values for WebApplicationFirewallAction. Possible values include: 'Allow', 'Block', 'Log'

readonly
enum

{string}

WebApplicationFirewallEnabledState

WebApplicationFirewallEnabledState: "Disabled" | "Enabled"

Defines values for WebApplicationFirewallEnabledState. Possible values include: 'Disabled', 'Enabled'

readonly
enum

{string}

WebApplicationFirewallMatchVariable

WebApplicationFirewallMatchVariable: "RemoteAddr" | "RequestMethod" | "QueryString" | "PostArgs" | "RequestUri" | "RequestHeaders" | "RequestBody" | "RequestCookies"

Defines values for WebApplicationFirewallMatchVariable. Possible values include: 'RemoteAddr', 'RequestMethod', 'QueryString', 'PostArgs', 'RequestUri', 'RequestHeaders', 'RequestBody', 'RequestCookies'

readonly
enum

{string}

WebApplicationFirewallMode

WebApplicationFirewallMode: "Prevention" | "Detection"

Defines values for WebApplicationFirewallMode. Possible values include: 'Prevention', 'Detection'

readonly
enum

{string}

WebApplicationFirewallOperator

WebApplicationFirewallOperator: "IPMatch" | "Equal" | "Contains" | "LessThan" | "GreaterThan" | "LessThanOrEqual" | "GreaterThanOrEqual" | "BeginsWith" | "EndsWith" | "Regex"

Defines values for WebApplicationFirewallOperator. Possible values include: 'IPMatch', 'Equal', 'Contains', 'LessThan', 'GreaterThan', 'LessThanOrEqual', 'GreaterThanOrEqual', 'BeginsWith', 'EndsWith', 'Regex'

readonly
enum

{string}

WebApplicationFirewallPoliciesCreateOrUpdateResponse

WebApplicationFirewallPoliciesCreateOrUpdateResponse: WebApplicationFirewallPolicy & object

Contains response data for the createOrUpdate operation.

WebApplicationFirewallPoliciesGetResponse

WebApplicationFirewallPoliciesGetResponse: WebApplicationFirewallPolicy & object

Contains response data for the get operation.

WebApplicationFirewallPoliciesListAllNextResponse

WebApplicationFirewallPoliciesListAllNextResponse: WebApplicationFirewallPolicyListResult & object

Contains response data for the listAllNext operation.

WebApplicationFirewallPoliciesListAllResponse

WebApplicationFirewallPoliciesListAllResponse: WebApplicationFirewallPolicyListResult & object

Contains response data for the listAll operation.

WebApplicationFirewallPoliciesListNextResponse

WebApplicationFirewallPoliciesListNextResponse: WebApplicationFirewallPolicyListResult & object

Contains response data for the listNext operation.

WebApplicationFirewallPoliciesListResponse

WebApplicationFirewallPoliciesListResponse: WebApplicationFirewallPolicyListResult & object

Contains response data for the list operation.

WebApplicationFirewallPolicyResourceState

WebApplicationFirewallPolicyResourceState: "Creating" | "Enabling" | "Enabled" | "Disabling" | "Disabled" | "Deleting"

Defines values for WebApplicationFirewallPolicyResourceState. Possible values include: 'Creating', 'Enabling', 'Enabled', 'Disabling', 'Disabled', 'Deleting'

readonly
enum

{string}

WebApplicationFirewallRuleType

WebApplicationFirewallRuleType: "MatchRule" | "Invalid"

Defines values for WebApplicationFirewallRuleType. Possible values include: 'MatchRule', 'Invalid'

readonly
enum

{string}

WebApplicationFirewallTransform

WebApplicationFirewallTransform: "Lowercase" | "Trim" | "UrlDecode" | "UrlEncode" | "RemoveNulls" | "HtmlEntityDecode"

Defines values for WebApplicationFirewallTransform. Possible values include: 'Lowercase', 'Trim', 'UrlDecode', 'UrlEncode', 'RemoveNulls', 'HtmlEntityDecode'

readonly
enum

{string}

Variables

Const BaseResource

BaseResource: CompositeMapper = BaseResourceMapper

Const CloudError

CloudError: CompositeMapper = CloudErrorMapper

Object literals

Const AddressSpace

AddressSpace: object

AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.

Optional addressPrefixes

addressPrefixes: string[]

A list of address blocks reserved for this virtual network in CIDR notation.

serializedName

serializedName: string = "AddressSpace"

type

type: object

className

className: string = "AddressSpace"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

addressPrefixes

addressPrefixes: object

serializedName

serializedName: string = "addressPrefixes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const ApplicationGateway

ApplicationGateway: object

Application gateway resource.

Optional authenticationCertificates

authenticationCertificates: ApplicationGatewayAuthenticationCertificate[]

Authentication certificates of the application gateway resource. For default limits, see Application Gateway limits.

Optional autoscaleConfiguration

Autoscale Configuration.

Optional backendAddressPools

backendAddressPools: ApplicationGatewayBackendAddressPool[]

Backend address pool of the application gateway resource. For default limits, see Application Gateway limits.

Optional backendHttpSettingsCollection

backendHttpSettingsCollection: ApplicationGatewayBackendHttpSettings[]

Backend http settings of the application gateway resource. For default limits, see Application Gateway limits.

Optional customErrorConfigurations

customErrorConfigurations: ApplicationGatewayCustomError[]

Custom error configurations of the application gateway resource.

Optional enableFips

enableFips: undefined | false | true

Whether FIPS is enabled on the application gateway resource.

Optional enableHttp2

enableHttp2: undefined | false | true

Whether HTTP2 is enabled on the application gateway resource.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional firewallPolicy

firewallPolicy: SubResource

Reference of the FirewallPolicy resource.

Optional frontendIPConfigurations

frontendIPConfigurations: ApplicationGatewayFrontendIPConfiguration[]

Frontend IP addresses of the application gateway resource. For default limits, see Application Gateway limits.

Optional frontendPorts

frontendPorts: ApplicationGatewayFrontendPort[]

Frontend ports of the application gateway resource. For default limits, see Application Gateway limits.

Optional gatewayIPConfigurations

gatewayIPConfigurations: ApplicationGatewayIPConfiguration[]

Subnets of the application gateway resource. For default limits, see Application Gateway limits.

Optional httpListeners

httpListeners: ApplicationGatewayHttpListener[]

Http listeners of the application gateway resource. For default limits, see Application Gateway limits.

Optional id

id: undefined | string

Resource ID.

Optional identity

The identity of the application gateway, if configured.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional operationalState

Operational state of the application gateway resource. Possible values include: 'Stopped', 'Starting', 'Running', 'Stopping' NOTE: This property will not be serialized. It can only be populated by the server.

Optional probes

probes: ApplicationGatewayProbe[]

Probes of the application gateway resource.

Optional provisioningState

provisioningState: undefined | string

Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

Optional redirectConfigurations

redirectConfigurations: ApplicationGatewayRedirectConfiguration[]

Redirect configurations of the application gateway resource. For default limits, see Application Gateway limits.

Optional requestRoutingRules

requestRoutingRules: ApplicationGatewayRequestRoutingRule[]

Request routing rules of the application gateway resource.

Optional resourceGuid

resourceGuid: undefined | string

Resource GUID property of the application gateway resource.

Optional rewriteRuleSets

rewriteRuleSets: ApplicationGatewayRewriteRuleSet[]

Rewrite rules for the application gateway resource.

serializedName

serializedName: string = "ApplicationGateway"

Optional sku

SKU of the application gateway resource.

Optional sslCertificates

sslCertificates: ApplicationGatewaySslCertificate[]

SSL certificates of the application gateway resource. For default limits, see Application Gateway limits.

Optional sslPolicy

SSL policy of the application gateway resource.

Optional tags

tags: undefined | object

Resource tags.

Optional trustedRootCertificates

trustedRootCertificates: ApplicationGatewayTrustedRootCertificate[]

Trusted Root certificates of the application gateway resource. For default limits, see Application Gateway limits.

Optional urlPathMaps

urlPathMaps: ApplicationGatewayUrlPathMap[]

URL path map of the application gateway resource. For default limits, see Application Gateway limits.

Optional webApplicationFirewallConfiguration

webApplicationFirewallConfiguration: ApplicationGatewayWebApplicationFirewallConfiguration

Web application firewall configuration.

Optional zones

zones: string[]

A list of availability zones denoting where the resource needs to come from.

type

type: object

className

className: string = "ApplicationGateway"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

authenticationCertificates

authenticationCertificates: object

serializedName

serializedName: string = "properties.authenticationCertificates"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationGatewayAuthenticationCertificate"

name

name: "Composite" = "Composite"

autoscaleConfiguration

autoscaleConfiguration: object

serializedName

serializedName: string = "properties.autoscaleConfiguration"

type

type: object

className

className: string = "ApplicationGatewayAutoscaleConfiguration"

name

name: "Composite" = "Composite"

backendAddressPools

backendAddressPools: object

serializedName

serializedName: string = "properties.backendAddressPools"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationGatewayBackendAddressPool"

name

name: "Composite" = "Composite"

backendHttpSettingsCollection

backendHttpSettingsCollection: object

serializedName

serializedName: string = "properties.backendHttpSettingsCollection"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationGatewayBackendHttpSettings"

name

name: "Composite" = "Composite"

customErrorConfigurations

customErrorConfigurations: object

serializedName

serializedName: string = "properties.customErrorConfigurations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationGatewayCustomError"

name

name: "Composite" = "Composite"

enableFips

enableFips: object

serializedName

serializedName: string = "properties.enableFips"

type

type: object

name

name: "Boolean" = "Boolean"

enableHttp2

enableHttp2: object

serializedName

serializedName: string = "properties.enableHttp2"

type

type: object

name

name: "Boolean" = "Boolean"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

firewallPolicy

firewallPolicy: object

serializedName

serializedName: string = "properties.firewallPolicy"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

frontendIPConfigurations

frontendIPConfigurations: object

serializedName

serializedName: string = "properties.frontendIPConfigurations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationGatewayFrontendIPConfiguration"

name

name: "Composite" = "Composite"

frontendPorts

frontendPorts: object

serializedName

serializedName: string = "properties.frontendPorts"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationGatewayFrontendPort"

name

name: "Composite" = "Composite"

gatewayIPConfigurations

gatewayIPConfigurations: object

serializedName

serializedName: string = "properties.gatewayIPConfigurations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationGatewayIPConfiguration"

name

name: "Composite" = "Composite"

httpListeners

httpListeners: object

serializedName

serializedName: string = "properties.httpListeners"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationGatewayHttpListener"

name

name: "Composite" = "Composite"

identity

identity: object

serializedName

serializedName: string = "identity"

type

type: object

className

className: string = "ManagedServiceIdentity"

name

name: "Composite" = "Composite"

operationalState

operationalState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.operationalState"

type

type: object

name

name: "String" = "String"

probes

probes: object

serializedName

serializedName: string = "properties.probes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationGatewayProbe"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

redirectConfigurations

redirectConfigurations: object

serializedName

serializedName: string = "properties.redirectConfigurations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationGatewayRedirectConfiguration"

name

name: "Composite" = "Composite"

requestRoutingRules

requestRoutingRules: object

serializedName

serializedName: string = "properties.requestRoutingRules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationGatewayRequestRoutingRule"

name

name: "Composite" = "Composite"

resourceGuid

resourceGuid: object

serializedName

serializedName: string = "properties.resourceGuid"

type

type: object

name

name: "String" = "String"

rewriteRuleSets

rewriteRuleSets: object

serializedName

serializedName: string = "properties.rewriteRuleSets"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationGatewayRewriteRuleSet"

name

name: "Composite" = "Composite"

sku

sku: object

serializedName

serializedName: string = "properties.sku"

type

type: object

className

className: string = "ApplicationGatewaySku"

name

name: "Composite" = "Composite"

sslCertificates

sslCertificates: object

serializedName

serializedName: string = "properties.sslCertificates"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationGatewaySslCertificate"

name

name: "Composite" = "Composite"

sslPolicy

sslPolicy: object

serializedName

serializedName: string = "properties.sslPolicy"

type

type: object

className

className: string = "ApplicationGatewaySslPolicy"

name

name: "Composite" = "Composite"

trustedRootCertificates

trustedRootCertificates: object

serializedName

serializedName: string = "properties.trustedRootCertificates"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationGatewayTrustedRootCertificate"

name

name: "Composite" = "Composite"

urlPathMaps

urlPathMaps: object

serializedName

serializedName: string = "properties.urlPathMaps"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationGatewayUrlPathMap"

name

name: "Composite" = "Composite"

webApplicationFirewallConfiguration

webApplicationFirewallConfiguration: object

serializedName

serializedName: string = "properties.webApplicationFirewallConfiguration"

type

type: object

className

className: string = "ApplicationGatewayWebApplicationFirewallConfiguration"

name

name: "Composite" = "Composite"

zones

zones: object

serializedName

serializedName: string = "zones"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const ApplicationGatewayAuthenticationCertificate

ApplicationGatewayAuthenticationCertificate: object

Authentication certificates of an application gateway.

Optional data

data: undefined | string

Certificate public data.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

Name of the authentication certificate that is unique within an Application Gateway.

Optional provisioningState

provisioningState: undefined | string

Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

serializedName

serializedName: string = "ApplicationGatewayAuthenticationCertificate"

type

type: object

Type of the resource.

className

className: string = "ApplicationGatewayAuthenticationCertificate"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

data

data: object

serializedName

serializedName: string = "properties.data"

type

type: object

name

name: "String" = "String"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const ApplicationGatewayAutoscaleConfiguration

ApplicationGatewayAutoscaleConfiguration: object

Application Gateway autoscale configuration.

Optional maxCapacity

maxCapacity: undefined | number

Upper bound on number of Application Gateway capacity.

minCapacity

minCapacity: number

Lower bound on number of Application Gateway capacity.

serializedName

serializedName: string = "ApplicationGatewayAutoscaleConfiguration"

type

type: object

className

className: string = "ApplicationGatewayAutoscaleConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

maxCapacity

maxCapacity: object

serializedName

serializedName: string = "maxCapacity"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 2

type

type: object

name

name: "Number" = "Number"

minCapacity

minCapacity: object

required

required: true = true

serializedName

serializedName: string = "minCapacity"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: "Number" = "Number"

Const ApplicationGatewayAvailableSslOptions

ApplicationGatewayAvailableSslOptions: object

Response for ApplicationGatewayAvailableSslOptions API service call.

Optional availableCipherSuites

availableCipherSuites: ApplicationGatewaySslCipherSuite[]

List of available Ssl cipher suites.

Optional availableProtocols

availableProtocols: ApplicationGatewaySslProtocol[]

List of available Ssl protocols.

Optional defaultPolicy

Name of the Ssl predefined policy applied by default to application gateway. Possible values include: 'AppGwSslPolicy20150501', 'AppGwSslPolicy20170401', 'AppGwSslPolicy20170401S'

Optional id

id: undefined | string

Resource ID.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional predefinedPolicies

predefinedPolicies: SubResource[]

List of available Ssl predefined policy.

serializedName

serializedName: string = "ApplicationGatewayAvailableSslOptions"

Optional tags

tags: undefined | object

Resource tags.

type

type: object

className

className: string = "ApplicationGatewayAvailableSslOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

availableCipherSuites

availableCipherSuites: object

serializedName

serializedName: string = "properties.availableCipherSuites"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

availableProtocols

availableProtocols: object

serializedName

serializedName: string = "properties.availableProtocols"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

defaultPolicy

defaultPolicy: object

serializedName

serializedName: string = "properties.defaultPolicy"

type

type: object

name

name: "String" = "String"

predefinedPolicies

predefinedPolicies: object

serializedName

serializedName: string = "properties.predefinedPolicies"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

Const ApplicationGatewayAvailableSslPredefinedPolicies

ApplicationGatewayAvailableSslPredefinedPolicies: object
interface

Response for ApplicationGatewayAvailableSslOptions API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

URL to get the next set of results.

serializedName

serializedName: string = "ApplicationGatewayAvailableSslPredefinedPolicies"

__@iterator

  • __@iterator(): IterableIterator<ApplicationGatewaySslPredefinedPolicy>
  • Iterator

    Returns IterableIterator<ApplicationGatewaySslPredefinedPolicy>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ApplicationGatewaySslPredefinedPolicy>[]): ApplicationGatewaySslPredefinedPolicy[]
  • concat(...items: (T | ConcatArray<T>)[]): ApplicationGatewaySslPredefinedPolicy[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ApplicationGatewaySslPredefinedPolicy>[]

      Additional items to add to the end of array1.

    Returns ApplicationGatewaySslPredefinedPolicy[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ApplicationGatewaySslPredefinedPolicy[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ApplicationGatewaySslPredefinedPolicy]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ApplicationGatewaySslPredefinedPolicy]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ApplicationGatewaySslPredefinedPolicy, index: number, array: ApplicationGatewaySslPredefinedPolicy[]): boolean
        • Parameters

          • value: ApplicationGatewaySslPredefinedPolicy
          • index: number
          • array: ApplicationGatewaySslPredefinedPolicy[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ApplicationGatewaySslPredefinedPolicy, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ApplicationGatewaySslPredefinedPolicy

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ApplicationGatewaySslPredefinedPolicy[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ApplicationGatewaySslPredefinedPolicy

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ApplicationGatewaySslPredefinedPolicy, index: number, array: ApplicationGatewaySslPredefinedPolicy[]): boolean
        • Parameters

          • value: ApplicationGatewaySslPredefinedPolicy
          • index: number
          • array: ApplicationGatewaySslPredefinedPolicy[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ApplicationGatewaySslPredefinedPolicy, index: number, array: ApplicationGatewaySslPredefinedPolicy[]): any
        • Parameters

          • value: ApplicationGatewaySslPredefinedPolicy
          • index: number
          • array: ApplicationGatewaySslPredefinedPolicy[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ApplicationGatewaySslPredefinedPolicy[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ApplicationGatewaySslPredefinedPolicy | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ApplicationGatewaySslPredefinedPolicy

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ApplicationGatewaySslPredefinedPolicy, index: number, obj: ApplicationGatewaySslPredefinedPolicy[]): boolean
        • Parameters

          • this: void
          • value: ApplicationGatewaySslPredefinedPolicy
          • index: number
          • obj: ApplicationGatewaySslPredefinedPolicy[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ApplicationGatewaySslPredefinedPolicy, index: number, obj: ApplicationGatewaySslPredefinedPolicy[]): boolean
        • Parameters

          • value: ApplicationGatewaySslPredefinedPolicy
          • index: number
          • obj: ApplicationGatewaySslPredefinedPolicy[]

          Returns boolean

    • Optional thisArg: any

    Returns ApplicationGatewaySslPredefinedPolicy | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ApplicationGatewaySslPredefinedPolicy, index: number, obj: ApplicationGatewaySslPredefinedPolicy[]): boolean
        • Parameters

          • value: ApplicationGatewaySslPredefinedPolicy
          • index: number
          • obj: ApplicationGatewaySslPredefinedPolicy[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ApplicationGatewaySslPredefinedPolicy, index: number, array: ApplicationGatewaySslPredefinedPolicy[]): void
        • Parameters

          • value: ApplicationGatewaySslPredefinedPolicy
          • index: number
          • array: ApplicationGatewaySslPredefinedPolicy[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ApplicationGatewaySslPredefinedPolicy, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ApplicationGatewaySslPredefinedPolicy

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ApplicationGatewaySslPredefinedPolicy, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ApplicationGatewaySslPredefinedPolicy

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ApplicationGatewaySslPredefinedPolicy, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ApplicationGatewaySslPredefinedPolicy

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ApplicationGatewaySslPredefinedPolicy, index: number, array: ApplicationGatewaySslPredefinedPolicy[]): U
        • Parameters

          • value: ApplicationGatewaySslPredefinedPolicy
          • index: number
          • array: ApplicationGatewaySslPredefinedPolicy[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ApplicationGatewaySslPredefinedPolicy | undefined
  • Removes the last element from an array and returns it.

    Returns ApplicationGatewaySslPredefinedPolicy | undefined

push

  • push(...items: ApplicationGatewaySslPredefinedPolicy[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ApplicationGatewaySslPredefinedPolicy[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ApplicationGatewaySslPredefinedPolicy
  • reduce(callbackfn: function, initialValue: ApplicationGatewaySslPredefinedPolicy): ApplicationGatewaySslPredefinedPolicy
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ApplicationGatewaySslPredefinedPolicy, currentValue: ApplicationGatewaySslPredefinedPolicy, currentIndex: number, array: ApplicationGatewaySslPredefinedPolicy[]): ApplicationGatewaySslPredefinedPolicy
        • Parameters

          • previousValue: ApplicationGatewaySslPredefinedPolicy
          • currentValue: ApplicationGatewaySslPredefinedPolicy
          • currentIndex: number
          • array: ApplicationGatewaySslPredefinedPolicy[]

          Returns ApplicationGatewaySslPredefinedPolicy

    Returns ApplicationGatewaySslPredefinedPolicy

  • Parameters

    • callbackfn: function
        • (previousValue: ApplicationGatewaySslPredefinedPolicy, currentValue: ApplicationGatewaySslPredefinedPolicy, currentIndex: number, array: ApplicationGatewaySslPredefinedPolicy[]): ApplicationGatewaySslPredefinedPolicy
        • Parameters

          • previousValue: ApplicationGatewaySslPredefinedPolicy
          • currentValue: ApplicationGatewaySslPredefinedPolicy
          • currentIndex: number
          • array: ApplicationGatewaySslPredefinedPolicy[]

          Returns ApplicationGatewaySslPredefinedPolicy

    • initialValue: ApplicationGatewaySslPredefinedPolicy

    Returns ApplicationGatewaySslPredefinedPolicy

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ApplicationGatewaySslPredefinedPolicy, currentIndex: number, array: ApplicationGatewaySslPredefinedPolicy[]): U
        • Parameters

          • previousValue: U
          • currentValue: ApplicationGatewaySslPredefinedPolicy
          • currentIndex: number
          • array: ApplicationGatewaySslPredefinedPolicy[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ApplicationGatewaySslPredefinedPolicy
  • reduceRight(callbackfn: function, initialValue: ApplicationGatewaySslPredefinedPolicy): ApplicationGatewaySslPredefinedPolicy
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ApplicationGatewaySslPredefinedPolicy, currentValue: ApplicationGatewaySslPredefinedPolicy, currentIndex: number, array: ApplicationGatewaySslPredefinedPolicy[]): ApplicationGatewaySslPredefinedPolicy
        • Parameters

          • previousValue: ApplicationGatewaySslPredefinedPolicy
          • currentValue: ApplicationGatewaySslPredefinedPolicy
          • currentIndex: number
          • array: ApplicationGatewaySslPredefinedPolicy[]

          Returns ApplicationGatewaySslPredefinedPolicy

    Returns ApplicationGatewaySslPredefinedPolicy

  • Parameters

    • callbackfn: function
        • (previousValue: ApplicationGatewaySslPredefinedPolicy, currentValue: ApplicationGatewaySslPredefinedPolicy, currentIndex: number, array: ApplicationGatewaySslPredefinedPolicy[]): ApplicationGatewaySslPredefinedPolicy
        • Parameters

          • previousValue: ApplicationGatewaySslPredefinedPolicy
          • currentValue: ApplicationGatewaySslPredefinedPolicy
          • currentIndex: number
          • array: ApplicationGatewaySslPredefinedPolicy[]

          Returns ApplicationGatewaySslPredefinedPolicy

    • initialValue: ApplicationGatewaySslPredefinedPolicy

    Returns ApplicationGatewaySslPredefinedPolicy

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ApplicationGatewaySslPredefinedPolicy, currentIndex: number, array: ApplicationGatewaySslPredefinedPolicy[]): U
        • Parameters

          • previousValue: U
          • currentValue: ApplicationGatewaySslPredefinedPolicy
          • currentIndex: number
          • array: ApplicationGatewaySslPredefinedPolicy[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ApplicationGatewaySslPredefinedPolicy[]
  • Reverses the elements in an Array.

    Returns ApplicationGatewaySslPredefinedPolicy[]

shift

  • shift(): ApplicationGatewaySslPredefinedPolicy | undefined
  • Removes the first element from an array and returns it.

    Returns ApplicationGatewaySslPredefinedPolicy | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ApplicationGatewaySslPredefinedPolicy[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ApplicationGatewaySslPredefinedPolicy[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ApplicationGatewaySslPredefinedPolicy, index: number, array: ApplicationGatewaySslPredefinedPolicy[]): boolean
        • Parameters

          • value: ApplicationGatewaySslPredefinedPolicy
          • index: number
          • array: ApplicationGatewaySslPredefinedPolicy[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ApplicationGatewaySslPredefinedPolicy[]
  • splice(start: number, deleteCount: number, ...items: ApplicationGatewaySslPredefinedPolicy[]): ApplicationGatewaySslPredefinedPolicy[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ApplicationGatewaySslPredefinedPolicy[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ApplicationGatewaySslPredefinedPolicy[]

      Elements to insert into the array in place of the deleted elements.

    Returns ApplicationGatewaySslPredefinedPolicy[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ApplicationGatewaySslPredefinedPolicy[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ApplicationGatewaySslPredefinedPolicy[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ApplicationGatewaySslPredefinedPolicy>
  • Returns an iterable of values in the array

    Returns IterableIterator<ApplicationGatewaySslPredefinedPolicy>

type

type: object

className

className: string = "ApplicationGatewayAvailableSslPredefinedPolicies"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationGatewaySslPredefinedPolicy"

name

name: "Composite" = "Composite"

Const ApplicationGatewayAvailableWafRuleSetsResult

ApplicationGatewayAvailableWafRuleSetsResult: object

Response for ApplicationGatewayAvailableWafRuleSets API service call.

serializedName

serializedName: string = "ApplicationGatewayAvailableWafRuleSetsResult"

Optional value

value: ApplicationGatewayFirewallRuleSet[]

The list of application gateway rule sets.

type

type: object

className

className: string = "ApplicationGatewayAvailableWafRuleSetsResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationGatewayFirewallRuleSet"

name

name: "Composite" = "Composite"

Const ApplicationGatewayBackendAddress

ApplicationGatewayBackendAddress: object

Backend address of an application gateway.

Optional fqdn

fqdn: undefined | string

Fully qualified domain name (FQDN).

Optional ipAddress

ipAddress: undefined | string

IP address.

serializedName

serializedName: string = "ApplicationGatewayBackendAddress"

type

type: object

className

className: string = "ApplicationGatewayBackendAddress"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

fqdn

fqdn: object

serializedName

serializedName: string = "fqdn"

type

type: object

name

name: "String" = "String"

ipAddress

ipAddress: object

serializedName

serializedName: string = "ipAddress"

type

type: object

name

name: "String" = "String"

Const ApplicationGatewayBackendAddressPool

ApplicationGatewayBackendAddressPool: object

Backend Address Pool of an application gateway.

Optional backendAddresses

backendAddresses: ApplicationGatewayBackendAddress[]

Backend addresses.

Optional backendIPConfigurations

backendIPConfigurations: NetworkInterfaceIPConfiguration[]

Collection of references to IPs defined in network interfaces.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

Name of the backend address pool that is unique within an Application Gateway.

Optional provisioningState

provisioningState: undefined | string

Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

serializedName

serializedName: string = "ApplicationGatewayBackendAddressPool"

type

type: object

Type of the resource.

className

className: string = "ApplicationGatewayBackendAddressPool"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backendAddresses

backendAddresses: object

serializedName

serializedName: string = "properties.backendAddresses"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationGatewayBackendAddress"

name

name: "Composite" = "Composite"

backendIPConfigurations

backendIPConfigurations: object

serializedName

serializedName: string = "properties.backendIPConfigurations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NetworkInterfaceIPConfiguration"

name

name: "Composite" = "Composite"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const ApplicationGatewayBackendHealth

ApplicationGatewayBackendHealth: object

Response for ApplicationGatewayBackendHealth API service call.

Optional backendAddressPools

backendAddressPools: ApplicationGatewayBackendHealthPool[]

A list of ApplicationGatewayBackendHealthPool resources.

serializedName

serializedName: string = "ApplicationGatewayBackendHealth"

type

type: object

className

className: string = "ApplicationGatewayBackendHealth"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backendAddressPools

backendAddressPools: object

serializedName

serializedName: string = "backendAddressPools"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationGatewayBackendHealthPool"

name

name: "Composite" = "Composite"

Const ApplicationGatewayBackendHealthHttpSettings

ApplicationGatewayBackendHealthHttpSettings: object

Application gateway BackendHealthHttp settings.

Optional backendHttpSettings

Reference of an ApplicationGatewayBackendHttpSettings resource.

serializedName

serializedName: string = "ApplicationGatewayBackendHealthHttpSettings"

Optional servers

servers: ApplicationGatewayBackendHealthServer[]

List of ApplicationGatewayBackendHealthServer resources.

type

type: object

className

className: string = "ApplicationGatewayBackendHealthHttpSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backendHttpSettings

backendHttpSettings: object

serializedName

serializedName: string = "backendHttpSettings"

type

type: object

className

className: string = "ApplicationGatewayBackendHttpSettings"

name

name: "Composite" = "Composite"

servers

servers: object

serializedName

serializedName: string = "servers"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationGatewayBackendHealthServer"

name

name: "Composite" = "Composite"

Const ApplicationGatewayBackendHealthOnDemand

ApplicationGatewayBackendHealthOnDemand: object

Result of on demand test probe.

Optional backendAddressPool

Reference of an ApplicationGatewayBackendAddressPool resource.

Optional backendHealthHttpSettings

Application gateway BackendHealthHttp settings.

serializedName

serializedName: string = "ApplicationGatewayBackendHealthOnDemand"

type

type: object

className

className: string = "ApplicationGatewayBackendHealthOnDemand"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backendAddressPool

backendAddressPool: object

serializedName

serializedName: string = "backendAddressPool"

type

type: object

className

className: string = "ApplicationGatewayBackendAddressPool"

name

name: "Composite" = "Composite"

backendHealthHttpSettings

backendHealthHttpSettings: object

serializedName

serializedName: string = "backendHealthHttpSettings"

type

type: object

className

className: string = "ApplicationGatewayBackendHealthHttpSettings"

name

name: "Composite" = "Composite"

Const ApplicationGatewayBackendHealthPool

ApplicationGatewayBackendHealthPool: object

Application gateway BackendHealth pool.

Optional backendAddressPool

Reference of an ApplicationGatewayBackendAddressPool resource.

Optional backendHttpSettingsCollection

backendHttpSettingsCollection: ApplicationGatewayBackendHealthHttpSettings[]

List of ApplicationGatewayBackendHealthHttpSettings resources.

serializedName

serializedName: string = "ApplicationGatewayBackendHealthPool"

type

type: object

className

className: string = "ApplicationGatewayBackendHealthPool"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backendAddressPool

backendAddressPool: object

serializedName

serializedName: string = "backendAddressPool"

type

type: object

className

className: string = "ApplicationGatewayBackendAddressPool"

name

name: "Composite" = "Composite"

backendHttpSettingsCollection

backendHttpSettingsCollection: object

serializedName

serializedName: string = "backendHttpSettingsCollection"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationGatewayBackendHealthHttpSettings"

name

name: "Composite" = "Composite"

Const ApplicationGatewayBackendHealthServer

ApplicationGatewayBackendHealthServer: object

Application gateway backendhealth http settings.

Optional address

address: undefined | string

IP address or FQDN of backend server.

Optional health

Health of backend server. Possible values include: 'Unknown', 'Up', 'Down', 'Partial', 'Draining'

Optional healthProbeLog

healthProbeLog: undefined | string

Health Probe Log.

Optional ipConfiguration

Reference of IP configuration of backend server.

serializedName

serializedName: string = "ApplicationGatewayBackendHealthServer"

type

type: object

className

className: string = "ApplicationGatewayBackendHealthServer"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

address

address: object

serializedName

serializedName: string = "address"

type

type: object

name

name: "String" = "String"

health

health: object

serializedName

serializedName: string = "health"

type

type: object

name

name: "String" = "String"

healthProbeLog

healthProbeLog: object

serializedName

serializedName: string = "healthProbeLog"

type

type: object

name

name: "String" = "String"

ipConfiguration

ipConfiguration: object

serializedName

serializedName: string = "ipConfiguration"

type

type: object

className

className: string = "NetworkInterfaceIPConfiguration"

name

name: "Composite" = "Composite"

Const ApplicationGatewayBackendHttpSettings

ApplicationGatewayBackendHttpSettings: object

Backend address pool settings of an application gateway.

Optional affinityCookieName

affinityCookieName: undefined | string

Cookie name to use for the affinity cookie.

Optional authenticationCertificates

authenticationCertificates: SubResource[]

Array of references to application gateway authentication certificates.

Optional connectionDraining

Connection draining of the backend http settings resource.

Optional cookieBasedAffinity

Cookie based affinity. Possible values include: 'Enabled', 'Disabled'

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional hostName

hostName: undefined | string

Host header to be sent to the backend servers.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

Name of the backend http settings that is unique within an Application Gateway.

Optional path

path: undefined | string

Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null.

Optional pickHostNameFromBackendAddress

pickHostNameFromBackendAddress: undefined | false | true

Whether to pick host header should be picked from the host name of the backend server. Default value is false.

Optional port

port: undefined | number

The destination port on the backend.

Optional probe

Probe resource of an application gateway.

Optional probeEnabled

probeEnabled: undefined | false | true

Whether the probe is enabled. Default value is false.

Optional protocol

The protocol used to communicate with the backend. Possible values include: 'Http', 'Https'

Optional provisioningState

provisioningState: undefined | string

Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

Optional requestTimeout

requestTimeout: undefined | number

Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds.

serializedName

serializedName: string = "ApplicationGatewayBackendHttpSettings"

Optional trustedRootCertificates

trustedRootCertificates: SubResource[]

Array of references to application gateway trusted root certificates.

type

type: object

Type of the resource.

className

className: string = "ApplicationGatewayBackendHttpSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

affinityCookieName

affinityCookieName: object

serializedName

serializedName: string = "properties.affinityCookieName"

type

type: object

name

name: "String" = "String"

authenticationCertificates

authenticationCertificates: object

serializedName

serializedName: string = "properties.authenticationCertificates"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

connectionDraining

connectionDraining: object

serializedName

serializedName: string = "properties.connectionDraining"

type

type: object

className

className: string = "ApplicationGatewayConnectionDraining"

name

name: "Composite" = "Composite"

cookieBasedAffinity

cookieBasedAffinity: object

serializedName

serializedName: string = "properties.cookieBasedAffinity"

type

type: object

name

name: "String" = "String"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

hostName

hostName: object

serializedName

serializedName: string = "properties.hostName"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

path

path: object

serializedName

serializedName: string = "properties.path"

type

type: object

name

name: "String" = "String"

pickHostNameFromBackendAddress

pickHostNameFromBackendAddress: object

serializedName

serializedName: string = "properties.pickHostNameFromBackendAddress"

type

type: object

name

name: "Boolean" = "Boolean"

port

port: object

serializedName

serializedName: string = "properties.port"

type

type: object

name

name: "Number" = "Number"

probe

probe: object

serializedName

serializedName: string = "properties.probe"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

probeEnabled

probeEnabled: object

serializedName

serializedName: string = "properties.probeEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

protocol

protocol: object

serializedName

serializedName: string = "properties.protocol"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

requestTimeout

requestTimeout: object

serializedName

serializedName: string = "properties.requestTimeout"

type

type: object

name

name: "Number" = "Number"

trustedRootCertificates

trustedRootCertificates: object

serializedName

serializedName: string = "properties.trustedRootCertificates"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const ApplicationGatewayConnectionDraining

ApplicationGatewayConnectionDraining: object

Connection draining allows open connections to a backend server to be active for a specified time after the backend server got removed from the configuration.

drainTimeoutInSec

drainTimeoutInSec: number

The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds.

enabled

enabled: boolean

Whether connection draining is enabled or not.

serializedName

serializedName: string = "ApplicationGatewayConnectionDraining"

type

type: object

className

className: string = "ApplicationGatewayConnectionDraining"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

drainTimeoutInSec

drainTimeoutInSec: object

required

required: true = true

serializedName

serializedName: string = "drainTimeoutInSec"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 3600

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: "Number" = "Number"

enabled

enabled: object

required

required: true = true

serializedName

serializedName: string = "enabled"

type

type: object

name

name: "Boolean" = "Boolean"

Const ApplicationGatewayCustomError

ApplicationGatewayCustomError: object

Customer error of an application gateway.

Optional customErrorPageUrl

customErrorPageUrl: undefined | string

Error page URL of the application gateway customer error.

serializedName

serializedName: string = "ApplicationGatewayCustomError"

Optional statusCode

Status code of the application gateway customer error. Possible values include: 'HttpStatus403', 'HttpStatus502'

type

type: object

className

className: string = "ApplicationGatewayCustomError"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

customErrorPageUrl

customErrorPageUrl: object

serializedName

serializedName: string = "customErrorPageUrl"

type

type: object

name

name: "String" = "String"

statusCode

statusCode: object

serializedName

serializedName: string = "statusCode"

type

type: object

name

name: "String" = "String"

Const ApplicationGatewayFirewallDisabledRuleGroup

ApplicationGatewayFirewallDisabledRuleGroup: object

Allows to disable rules within a rule group or an entire rule group.

ruleGroupName

ruleGroupName: string

The name of the rule group that will be disabled.

Optional rules

rules: number[]

The list of rules that will be disabled. If null, all rules of the rule group will be disabled.

serializedName

serializedName: string = "ApplicationGatewayFirewallDisabledRuleGroup"

type

type: object

className

className: string = "ApplicationGatewayFirewallDisabledRuleGroup"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

ruleGroupName

ruleGroupName: object

required

required: true = true

serializedName

serializedName: string = "ruleGroupName"

type

type: object

name

name: "String" = "String"

rules

rules: object

serializedName

serializedName: string = "rules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "Number" = "Number"

Const ApplicationGatewayFirewallExclusion

ApplicationGatewayFirewallExclusion: object

Allow to exclude some variable satisfy the condition for the WAF check.

matchVariable

matchVariable: string

The variable to be excluded.

selector

selector: string

When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to.

selectorMatchOperator

selectorMatchOperator: string

When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to.

serializedName

serializedName: string = "ApplicationGatewayFirewallExclusion"

type

type: object

className

className: string = "ApplicationGatewayFirewallExclusion"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

matchVariable

matchVariable: object

required

required: true = true

serializedName

serializedName: string = "matchVariable"

type

type: object

name

name: "String" = "String"

selector

selector: object

required

required: true = true

serializedName

serializedName: string = "selector"

type

type: object

name

name: "String" = "String"

selectorMatchOperator

selectorMatchOperator: object

required

required: true = true

serializedName

serializedName: string = "selectorMatchOperator"

type

type: object

name

name: "String" = "String"

Const ApplicationGatewayFirewallRule

ApplicationGatewayFirewallRule: object

A web application firewall rule.

Optional description

description: undefined | string

The description of the web application firewall rule.

ruleId

ruleId: number

The identifier of the web application firewall rule.

serializedName

serializedName: string = "ApplicationGatewayFirewallRule"

type

type: object

className

className: string = "ApplicationGatewayFirewallRule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "String" = "String"

ruleId

ruleId: object

required

required: true = true

serializedName

serializedName: string = "ruleId"

type

type: object

name

name: "Number" = "Number"

Const ApplicationGatewayFirewallRuleGroup

ApplicationGatewayFirewallRuleGroup: object

A web application firewall rule group.

Optional description

description: undefined | string

The description of the web application firewall rule group.

ruleGroupName

ruleGroupName: string

The name of the web application firewall rule group.

rules

rules: ApplicationGatewayFirewallRule[]

The rules of the web application firewall rule group.

serializedName

serializedName: string = "ApplicationGatewayFirewallRuleGroup"

type

type: object

className

className: string = "ApplicationGatewayFirewallRuleGroup"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "String" = "String"

ruleGroupName

ruleGroupName: object

required

required: true = true

serializedName

serializedName: string = "ruleGroupName"

type

type: object

name

name: "String" = "String"

rules

rules: object

required

required: true = true

serializedName

serializedName: string = "rules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationGatewayFirewallRule"

name

name: "Composite" = "Composite"

Const ApplicationGatewayFirewallRuleSet

ApplicationGatewayFirewallRuleSet: object

A web application firewall rule set.

Optional id

id: undefined | string

Resource ID.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the web application firewall rule set.

ruleGroups

ruleGroups: ApplicationGatewayFirewallRuleGroup[]

The rule groups of the web application firewall rule set.

ruleSetType

ruleSetType: string

The type of the web application firewall rule set.

ruleSetVersion

ruleSetVersion: string

The version of the web application firewall rule set type.

serializedName

serializedName: string = "ApplicationGatewayFirewallRuleSet"

Optional tags

tags: undefined | object

Resource tags.

type

type: object

className

className: string = "ApplicationGatewayFirewallRuleSet"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

ruleGroups

ruleGroups: object

required

required: true = true

serializedName

serializedName: string = "properties.ruleGroups"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationGatewayFirewallRuleGroup"

name

name: "Composite" = "Composite"

ruleSetType

ruleSetType: object

required

required: true = true

serializedName

serializedName: string = "properties.ruleSetType"

type

type: object

name

name: "String" = "String"

ruleSetVersion

ruleSetVersion: object

required

required: true = true

serializedName

serializedName: string = "properties.ruleSetVersion"

type

type: object

name

name: "String" = "String"

Const ApplicationGatewayFrontendIPConfiguration

ApplicationGatewayFrontendIPConfiguration: object

Frontend IP configuration of an application gateway.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

Name of the frontend IP configuration that is unique within an Application Gateway.

Optional privateIPAddress

privateIPAddress: undefined | string

PrivateIPAddress of the network interface IP Configuration.

Optional privateIPAllocationMethod

privateIPAllocationMethod: IPAllocationMethod

The private IP address allocation method. Possible values include: 'Static', 'Dynamic'

Optional provisioningState

provisioningState: undefined | string

Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

Optional publicIPAddress

publicIPAddress: SubResource

Reference of the PublicIP resource.

serializedName

serializedName: string = "ApplicationGatewayFrontendIPConfiguration"

Optional subnet

subnet: SubResource

Reference of the subnet resource.

type

type: object

Type of the resource.

className

className: string = "ApplicationGatewayFrontendIPConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

privateIPAddress

privateIPAddress: object

serializedName

serializedName: string = "properties.privateIPAddress"

type

type: object

name

name: "String" = "String"

privateIPAllocationMethod

privateIPAllocationMethod: object

serializedName

serializedName: string = "properties.privateIPAllocationMethod"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

publicIPAddress

publicIPAddress: object

serializedName

serializedName: string = "properties.publicIPAddress"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

subnet

subnet: object

serializedName

serializedName: string = "properties.subnet"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const ApplicationGatewayFrontendPort

ApplicationGatewayFrontendPort: object

Frontend port of an application gateway.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

Name of the frontend port that is unique within an Application Gateway.

Optional port

port: undefined | number

Frontend port.

Optional provisioningState

provisioningState: undefined | string

Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

serializedName

serializedName: string = "ApplicationGatewayFrontendPort"

type

type: object

Type of the resource.

className

className: string = "ApplicationGatewayFrontendPort"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

port

port: object

serializedName

serializedName: string = "properties.port"

type

type: object

name

name: "Number" = "Number"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const ApplicationGatewayHeaderConfiguration

ApplicationGatewayHeaderConfiguration: object

Header configuration of the Actions set in Application Gateway.

Optional headerName

headerName: undefined | string

Header name of the header configuration.

Optional headerValue

headerValue: undefined | string

Header value of the header configuration.

serializedName

serializedName: string = "ApplicationGatewayHeaderConfiguration"

type

type: object

className

className: string = "ApplicationGatewayHeaderConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

headerName

headerName: object

serializedName

serializedName: string = "headerName"

type

type: object

name

name: "String" = "String"

headerValue

headerValue: object

serializedName

serializedName: string = "headerValue"

type

type: object

name

name: "String" = "String"

Const ApplicationGatewayHttpListener

ApplicationGatewayHttpListener: object

Http listener of an application gateway.

Optional customErrorConfigurations

customErrorConfigurations: ApplicationGatewayCustomError[]

Custom error configurations of the HTTP listener.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional frontendIPConfiguration

frontendIPConfiguration: SubResource

Frontend IP configuration resource of an application gateway.

Optional frontendPort

frontendPort: SubResource

Frontend port resource of an application gateway.

Optional hostName

hostName: undefined | string

Host name of HTTP listener.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

Name of the HTTP listener that is unique within an Application Gateway.

Optional protocol

Protocol of the HTTP listener. Possible values include: 'Http', 'Https'

Optional provisioningState

provisioningState: undefined | string

Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

Optional requireServerNameIndication

requireServerNameIndication: undefined | false | true

Applicable only if protocol is https. Enables SNI for multi-hosting.

serializedName

serializedName: string = "ApplicationGatewayHttpListener"

Optional sslCertificate

sslCertificate: SubResource

SSL certificate resource of an application gateway.

type

type: object

Type of the resource.

className

className: string = "ApplicationGatewayHttpListener"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

customErrorConfigurations

customErrorConfigurations: object

serializedName

serializedName: string = "properties.customErrorConfigurations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationGatewayCustomError"

name

name: "Composite" = "Composite"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

frontendIPConfiguration

frontendIPConfiguration: object

serializedName

serializedName: string = "properties.frontendIPConfiguration"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

frontendPort

frontendPort: object

serializedName

serializedName: string = "properties.frontendPort"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

hostName

hostName: object

serializedName

serializedName: string = "properties.hostName"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

protocol

protocol: object

serializedName

serializedName: string = "properties.protocol"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

requireServerNameIndication

requireServerNameIndication: object

serializedName

serializedName: string = "properties.requireServerNameIndication"

type

type: object

name

name: "Boolean" = "Boolean"

sslCertificate

sslCertificate: object

serializedName

serializedName: string = "properties.sslCertificate"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const ApplicationGatewayIPConfiguration

ApplicationGatewayIPConfiguration: object

IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

Name of the IP configuration that is unique within an Application Gateway.

Optional provisioningState

provisioningState: undefined | string

Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

serializedName

serializedName: string = "ApplicationGatewayIPConfiguration"

Optional subnet

subnet: SubResource

Reference of the subnet resource. A subnet from where application gateway gets its private address.

type

type: object

Type of the resource.

className

className: string = "ApplicationGatewayIPConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

subnet

subnet: object

serializedName

serializedName: string = "properties.subnet"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const ApplicationGatewayListResult

ApplicationGatewayListResult: object
interface

Response for ListApplicationGateways API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

URL to get the next set of results.

serializedName

serializedName: string = "ApplicationGatewayListResult"

__@iterator

  • __@iterator(): IterableIterator<ApplicationGateway>
  • Iterator

    Returns IterableIterator<ApplicationGateway>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ApplicationGateway>[]): ApplicationGateway[]
  • concat(...items: (T | ConcatArray<T>)[]): ApplicationGateway[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ApplicationGateway>[]

      Additional items to add to the end of array1.

    Returns ApplicationGateway[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ApplicationGateway[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ApplicationGateway]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ApplicationGateway]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ApplicationGateway, index: number, array: ApplicationGateway[]): boolean
        • Parameters

          • value: ApplicationGateway
          • index: number
          • array: ApplicationGateway[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ApplicationGateway, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ApplicationGateway

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ApplicationGateway[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ApplicationGateway

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ApplicationGateway, index: number, array: ApplicationGateway[]): boolean
        • Parameters

          • value: ApplicationGateway
          • index: number
          • array: ApplicationGateway[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ApplicationGateway, index: number, array: ApplicationGateway[]): any
        • Parameters

          • value: ApplicationGateway
          • index: number
          • array: ApplicationGateway[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ApplicationGateway[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ApplicationGateway | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ApplicationGateway

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ApplicationGateway, index: number, obj: ApplicationGateway[]): boolean
        • Parameters

          • this: void
          • value: ApplicationGateway
          • index: number
          • obj: ApplicationGateway[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ApplicationGateway, index: number, obj: ApplicationGateway[]): boolean
        • Parameters

          • value: ApplicationGateway
          • index: number
          • obj: ApplicationGateway[]

          Returns boolean

    • Optional thisArg: any

    Returns ApplicationGateway | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ApplicationGateway, index: number, obj: ApplicationGateway[]): boolean
        • Parameters

          • value: ApplicationGateway
          • index: number
          • obj: ApplicationGateway[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ApplicationGateway, index: number, array: ApplicationGateway[]): void
        • Parameters

          • value: ApplicationGateway
          • index: number
          • array: ApplicationGateway[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ApplicationGateway, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ApplicationGateway

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ApplicationGateway, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ApplicationGateway

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ApplicationGateway, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ApplicationGateway

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ApplicationGateway, index: number, array: ApplicationGateway[]): U
        • Parameters

          • value: ApplicationGateway
          • index: number
          • array: ApplicationGateway[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ApplicationGateway | undefined
  • Removes the last element from an array and returns it.

    Returns ApplicationGateway | undefined

push

  • push(...items: ApplicationGateway[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ApplicationGateway[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ApplicationGateway
  • reduce(callbackfn: function, initialValue: ApplicationGateway): ApplicationGateway
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ApplicationGateway, currentValue: ApplicationGateway, currentIndex: number, array: ApplicationGateway[]): ApplicationGateway
        • Parameters

          • previousValue: ApplicationGateway
          • currentValue: ApplicationGateway
          • currentIndex: number
          • array: ApplicationGateway[]

          Returns ApplicationGateway

    Returns ApplicationGateway

  • Parameters

    • callbackfn: function
        • (previousValue: ApplicationGateway, currentValue: ApplicationGateway, currentIndex: number, array: ApplicationGateway[]): ApplicationGateway
        • Parameters

          • previousValue: ApplicationGateway
          • currentValue: ApplicationGateway
          • currentIndex: number
          • array: ApplicationGateway[]

          Returns ApplicationGateway

    • initialValue: ApplicationGateway

    Returns ApplicationGateway

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ApplicationGateway, currentIndex: number, array: ApplicationGateway[]): U
        • Parameters

          • previousValue: U
          • currentValue: ApplicationGateway
          • currentIndex: number
          • array: ApplicationGateway[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ApplicationGateway
  • reduceRight(callbackfn: function, initialValue: ApplicationGateway): ApplicationGateway
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ApplicationGateway, currentValue: ApplicationGateway, currentIndex: number, array: ApplicationGateway[]): ApplicationGateway
        • Parameters

          • previousValue: ApplicationGateway
          • currentValue: ApplicationGateway
          • currentIndex: number
          • array: ApplicationGateway[]

          Returns ApplicationGateway

    Returns ApplicationGateway

  • Parameters

    • callbackfn: function
        • (previousValue: ApplicationGateway, currentValue: ApplicationGateway, currentIndex: number, array: ApplicationGateway[]): ApplicationGateway
        • Parameters

          • previousValue: ApplicationGateway
          • currentValue: ApplicationGateway
          • currentIndex: number
          • array: ApplicationGateway[]

          Returns ApplicationGateway

    • initialValue: ApplicationGateway

    Returns ApplicationGateway

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ApplicationGateway, currentIndex: number, array: ApplicationGateway[]): U
        • Parameters

          • previousValue: U
          • currentValue: ApplicationGateway
          • currentIndex: number
          • array: ApplicationGateway[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ApplicationGateway[]
  • Reverses the elements in an Array.

    Returns ApplicationGateway[]

shift

  • shift(): ApplicationGateway | undefined
  • Removes the first element from an array and returns it.

    Returns ApplicationGateway | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ApplicationGateway[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ApplicationGateway[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ApplicationGateway, index: number, array: ApplicationGateway[]): boolean
        • Parameters

          • value: ApplicationGateway
          • index: number
          • array: ApplicationGateway[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ApplicationGateway[]
  • splice(start: number, deleteCount: number, ...items: ApplicationGateway[]): ApplicationGateway[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ApplicationGateway[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ApplicationGateway[]

      Elements to insert into the array in place of the deleted elements.

    Returns ApplicationGateway[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ApplicationGateway[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ApplicationGateway[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ApplicationGateway>
  • Returns an iterable of values in the array

    Returns IterableIterator<ApplicationGateway>

type

type: object

className

className: string = "ApplicationGatewayListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationGateway"

name

name: "Composite" = "Composite"

Const ApplicationGatewayOnDemandProbe

ApplicationGatewayOnDemandProbe: object

Details of on demand test probe request.

Optional backendHttpSettingName

backendHttpSettingName: undefined | string

Name of backend http setting of application gateway to be used for test probe.

Optional backendPoolName

backendPoolName: undefined | string

Name of backend pool of application gateway to which probe request will be sent.

Optional host

host: undefined | string

Host name to send the probe to.

Optional match

Criterion for classifying a healthy probe response.

Optional path

path: undefined | string

Relative path of probe. Valid path starts from '/'. Probe is sent to ://:.

Optional pickHostNameFromBackendHttpSettings

pickHostNameFromBackendHttpSettings: undefined | false | true

Whether the host header should be picked from the backend http settings. Default value is false.

Optional protocol

The protocol used for the probe. Possible values include: 'Http', 'Https'

serializedName

serializedName: string = "ApplicationGatewayOnDemandProbe"

Optional timeout

timeout: undefined | number

The probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds.

type

type: object

className

className: string = "ApplicationGatewayOnDemandProbe"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backendHttpSettingName

backendHttpSettingName: object

serializedName

serializedName: string = "backendHttpSettingName"

type

type: object

name

name: "String" = "String"

backendPoolName

backendPoolName: object

serializedName

serializedName: string = "backendPoolName"

type

type: object

name

name: "String" = "String"

host

host: object

serializedName

serializedName: string = "host"

type

type: object

name

name: "String" = "String"

match

match: object

serializedName

serializedName: string = "match"

type

type: object

className

className: string = "ApplicationGatewayProbeHealthResponseMatch"

name

name: "Composite" = "Composite"

path

path: object

serializedName

serializedName: string = "path"

type

type: object

name

name: "String" = "String"

pickHostNameFromBackendHttpSettings

pickHostNameFromBackendHttpSettings: object

serializedName

serializedName: string = "pickHostNameFromBackendHttpSettings"

type

type: object

name

name: "Boolean" = "Boolean"

protocol

protocol: object

serializedName

serializedName: string = "protocol"

type

type: object

name

name: "String" = "String"

timeout

timeout: object

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const ApplicationGatewayPathRule

ApplicationGatewayPathRule: object

Path rule of URL path map of an application gateway.

Optional backendAddressPool

backendAddressPool: SubResource

Backend address pool resource of URL path map path rule.

Optional backendHttpSettings

backendHttpSettings: SubResource

Backend http settings resource of URL path map path rule.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

Name of the path rule that is unique within an Application Gateway.

Optional paths

paths: string[]

Path rules of URL path map.

Optional provisioningState

provisioningState: undefined | string

Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

Optional redirectConfiguration

redirectConfiguration: SubResource

Redirect configuration resource of URL path map path rule.

Optional rewriteRuleSet

rewriteRuleSet: SubResource

Rewrite rule set resource of URL path map path rule.

serializedName

serializedName: string = "ApplicationGatewayPathRule"

type

type: object

Type of the resource.

className

className: string = "ApplicationGatewayPathRule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backendAddressPool

backendAddressPool: object

serializedName

serializedName: string = "properties.backendAddressPool"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

backendHttpSettings

backendHttpSettings: object

serializedName

serializedName: string = "properties.backendHttpSettings"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

paths

paths: object

serializedName

serializedName: string = "properties.paths"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

redirectConfiguration

redirectConfiguration: object

serializedName

serializedName: string = "properties.redirectConfiguration"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

rewriteRuleSet

rewriteRuleSet: object

serializedName

serializedName: string = "properties.rewriteRuleSet"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const ApplicationGatewayProbe

ApplicationGatewayProbe: object

Probe of the application gateway.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional host

host: undefined | string

Host name to send the probe to.

Optional id

id: undefined | string

Resource ID.

Optional interval

interval: undefined | number

The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds.

Optional match

Criterion for classifying a healthy probe response.

Optional minServers

minServers: undefined | number

Minimum number of servers that are always marked healthy. Default value is 0.

Optional name

name: undefined | string

Name of the probe that is unique within an Application Gateway.

Optional path

path: undefined | string

Relative path of probe. Valid path starts from '/'. Probe is sent to ://:.

Optional pickHostNameFromBackendHttpSettings

pickHostNameFromBackendHttpSettings: undefined | false | true

Whether the host header should be picked from the backend http settings. Default value is false.

Optional port

port: undefined | number

Custom port which will be used for probing the backend servers. The valid value ranges from 1 to 65535. In case not set, port from http settings will be used. This property is valid for Standard_v2 and WAF_v2 only.

Optional protocol

The protocol used for the probe. Possible values include: 'Http', 'Https'

Optional provisioningState

provisioningState: undefined | string

Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

serializedName

serializedName: string = "ApplicationGatewayProbe"

Optional timeout

timeout: undefined | number

The probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds.

Optional unhealthyThreshold

unhealthyThreshold: undefined | number

The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20.

type

type: object

Type of the resource.

className

className: string = "ApplicationGatewayProbe"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

host

host: object

serializedName

serializedName: string = "properties.host"

type

type: object

name

name: "String" = "String"

interval

interval: object

serializedName

serializedName: string = "properties.interval"

type

type: object

name

name: "Number" = "Number"

match

match: object

serializedName

serializedName: string = "properties.match"

type

type: object

className

className: string = "ApplicationGatewayProbeHealthResponseMatch"

name

name: "Composite" = "Composite"

minServers

minServers: object

serializedName

serializedName: string = "properties.minServers"

type

type: object

name

name: "Number" = "Number"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

path

path: object

serializedName

serializedName: string = "properties.path"

type

type: object

name

name: "String" = "String"

pickHostNameFromBackendHttpSettings

pickHostNameFromBackendHttpSettings: object

serializedName

serializedName: string = "properties.pickHostNameFromBackendHttpSettings"

type

type: object

name

name: "Boolean" = "Boolean"

port

port: object

serializedName

serializedName: string = "properties.port"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 65535

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: "Number" = "Number"

protocol

protocol: object

serializedName

serializedName: string = "properties.protocol"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

timeout

timeout: object

serializedName

serializedName: string = "properties.timeout"

type

type: object

name

name: "Number" = "Number"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

unhealthyThreshold

unhealthyThreshold: object

serializedName

serializedName: string = "properties.unhealthyThreshold"

type

type: object

name

name: "Number" = "Number"

Const ApplicationGatewayProbeHealthResponseMatch

ApplicationGatewayProbeHealthResponseMatch: object

Application gateway probe health response match.

Optional body

body: undefined | string

Body that must be contained in the health response. Default value is empty.

serializedName

serializedName: string = "ApplicationGatewayProbeHealthResponseMatch"

Optional statusCodes

statusCodes: string[]

Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399.

type

type: object

className

className: string = "ApplicationGatewayProbeHealthResponseMatch"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

body

body: object

serializedName

serializedName: string = "body"

type

type: object

name

name: "String" = "String"

statusCodes

statusCodes: object

serializedName

serializedName: string = "statusCodes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const ApplicationGatewayRedirectConfiguration

ApplicationGatewayRedirectConfiguration: object

Redirect configuration of an application gateway.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional includePath

includePath: undefined | false | true

Include path in the redirected url.

Optional includeQueryString

includeQueryString: undefined | false | true

Include query string in the redirected url.

Optional name

name: undefined | string

Name of the redirect configuration that is unique within an Application Gateway.

Optional pathRules

pathRules: SubResource[]

Path rules specifying redirect configuration.

Optional redirectType

HTTP redirection type. Possible values include: 'Permanent', 'Found', 'SeeOther', 'Temporary'

Optional requestRoutingRules

requestRoutingRules: SubResource[]

Request routing specifying redirect configuration.

serializedName

serializedName: string = "ApplicationGatewayRedirectConfiguration"

Optional targetListener

targetListener: SubResource

Reference to a listener to redirect the request to.

Optional targetUrl

targetUrl: undefined | string

Url to redirect the request to.

Optional urlPathMaps

urlPathMaps: SubResource[]

Url path maps specifying default redirect configuration.

type

type: object

Type of the resource.

className

className: string = "ApplicationGatewayRedirectConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

includePath

includePath: object

serializedName

serializedName: string = "properties.includePath"

type

type: object

name

name: "Boolean" = "Boolean"

includeQueryString

includeQueryString: object

serializedName

serializedName: string = "properties.includeQueryString"

type

type: object

name

name: "Boolean" = "Boolean"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

pathRules

pathRules: object

serializedName

serializedName: string = "properties.pathRules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

redirectType

redirectType: object

serializedName

serializedName: string = "properties.redirectType"

type

type: object

name

name: "String" = "String"

requestRoutingRules

requestRoutingRules: object

serializedName

serializedName: string = "properties.requestRoutingRules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

targetListener

targetListener: object

serializedName

serializedName: string = "properties.targetListener"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

targetUrl

targetUrl: object

serializedName

serializedName: string = "properties.targetUrl"

type

type: object

name

name: "String" = "String"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

urlPathMaps

urlPathMaps: object

serializedName

serializedName: string = "properties.urlPathMaps"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

Const ApplicationGatewayRequestRoutingRule

ApplicationGatewayRequestRoutingRule: object

Request routing rule of an application gateway.

Optional backendAddressPool

backendAddressPool: SubResource

Backend address pool resource of the application gateway.

Optional backendHttpSettings

backendHttpSettings: SubResource

Backend http settings resource of the application gateway.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional httpListener

httpListener: SubResource

Http listener resource of the application gateway.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

Name of the request routing rule that is unique within an Application Gateway.

Optional provisioningState

provisioningState: undefined | string

Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

Optional redirectConfiguration

redirectConfiguration: SubResource

Redirect configuration resource of the application gateway.

Optional rewriteRuleSet

rewriteRuleSet: SubResource

Rewrite Rule Set resource in Basic rule of the application gateway.

Optional ruleType

Rule type. Possible values include: 'Basic', 'PathBasedRouting'

serializedName

serializedName: string = "ApplicationGatewayRequestRoutingRule"

Optional urlPathMap

urlPathMap: SubResource

URL path map resource of the application gateway.

type

type: object

Type of the resource.

className

className: string = "ApplicationGatewayRequestRoutingRule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backendAddressPool

backendAddressPool: object

serializedName

serializedName: string = "properties.backendAddressPool"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

backendHttpSettings

backendHttpSettings: object

serializedName

serializedName: string = "properties.backendHttpSettings"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

httpListener

httpListener: object

serializedName

serializedName: string = "properties.httpListener"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

redirectConfiguration

redirectConfiguration: object

serializedName

serializedName: string = "properties.redirectConfiguration"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

rewriteRuleSet

rewriteRuleSet: object

serializedName

serializedName: string = "properties.rewriteRuleSet"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

ruleType

ruleType: object

serializedName

serializedName: string = "properties.ruleType"

type

type: object

name

name: "String" = "String"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

urlPathMap

urlPathMap: object

serializedName

serializedName: string = "properties.urlPathMap"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

Const ApplicationGatewayRewriteRule

ApplicationGatewayRewriteRule: object

Rewrite rule of an application gateway.

Optional actionSet

Set of actions to be done as part of the rewrite Rule.

Optional conditions

conditions: ApplicationGatewayRewriteRuleCondition[]

Conditions based on which the action set execution will be evaluated.

Optional name

name: undefined | string

Name of the rewrite rule that is unique within an Application Gateway.

Optional ruleSequence

ruleSequence: undefined | number

Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet.

serializedName

serializedName: string = "ApplicationGatewayRewriteRule"

type

type: object

className

className: string = "ApplicationGatewayRewriteRule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

actionSet

actionSet: object

serializedName

serializedName: string = "actionSet"

type

type: object

className

className: string = "ApplicationGatewayRewriteRuleActionSet"

name

name: "Composite" = "Composite"

conditions

conditions: object

serializedName

serializedName: string = "conditions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationGatewayRewriteRuleCondition"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

ruleSequence

ruleSequence: object

serializedName

serializedName: string = "ruleSequence"

type

type: object

name

name: "Number" = "Number"

Const ApplicationGatewayRewriteRuleActionSet

ApplicationGatewayRewriteRuleActionSet: object

Set of actions in the Rewrite Rule in Application Gateway.

Optional requestHeaderConfigurations

requestHeaderConfigurations: ApplicationGatewayHeaderConfiguration[]

Request Header Actions in the Action Set.

Optional responseHeaderConfigurations

responseHeaderConfigurations: ApplicationGatewayHeaderConfiguration[]

Response Header Actions in the Action Set.

serializedName

serializedName: string = "ApplicationGatewayRewriteRuleActionSet"

type

type: object

className

className: string = "ApplicationGatewayRewriteRuleActionSet"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

requestHeaderConfigurations

requestHeaderConfigurations: object

serializedName

serializedName: string = "requestHeaderConfigurations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationGatewayHeaderConfiguration"

name

name: "Composite" = "Composite"

responseHeaderConfigurations

responseHeaderConfigurations: object

serializedName

serializedName: string = "responseHeaderConfigurations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationGatewayHeaderConfiguration"

name

name: "Composite" = "Composite"

Const ApplicationGatewayRewriteRuleCondition

ApplicationGatewayRewriteRuleCondition: object

Set of conditions in the Rewrite Rule in Application Gateway.

Optional ignoreCase

ignoreCase: undefined | false | true

Setting this paramter to truth value with force the pattern to do a case in-sensitive comparison.

Optional negate

negate: undefined | false | true

Setting this value as truth will force to check the negation of the condition given by the user.

Optional pattern

pattern: undefined | string

The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition.

serializedName

serializedName: string = "ApplicationGatewayRewriteRuleCondition"

Optional variable

variable: undefined | string

The condition parameter of the RewriteRuleCondition.

type

type: object

className

className: string = "ApplicationGatewayRewriteRuleCondition"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

ignoreCase

ignoreCase: object

serializedName

serializedName: string = "ignoreCase"

type

type: object

name

name: "Boolean" = "Boolean"

negate

negate: object

serializedName

serializedName: string = "negate"

type

type: object

name

name: "Boolean" = "Boolean"

pattern

pattern: object

serializedName

serializedName: string = "pattern"

type

type: object

name

name: "String" = "String"

variable

variable: object

serializedName

serializedName: string = "variable"

type

type: object

name

name: "String" = "String"

Const ApplicationGatewayRewriteRuleSet

ApplicationGatewayRewriteRuleSet: object

Rewrite rule set of an application gateway.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

Name of the rewrite rule set that is unique within an Application Gateway.

Optional provisioningState

provisioningState: undefined | string

Provisioning state of the rewrite rule set resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. NOTE: This property will not be serialized. It can only be populated by the server.

Optional rewriteRules

rewriteRules: ApplicationGatewayRewriteRule[]

Rewrite rules in the rewrite rule set.

serializedName

serializedName: string = "ApplicationGatewayRewriteRuleSet"

type

type: object

className

className: string = "ApplicationGatewayRewriteRuleSet"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

etag

etag: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

rewriteRules

rewriteRules: object

serializedName

serializedName: string = "properties.rewriteRules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationGatewayRewriteRule"

name

name: "Composite" = "Composite"

Const ApplicationGatewaySku

ApplicationGatewaySku: object

SKU of an application gateway.

Optional capacity

capacity: undefined | number

Capacity (instance count) of an application gateway.

Optional name

Name of an application gateway SKU. Possible values include: 'Standard_Small', 'Standard_Medium', 'Standard_Large', 'WAF_Medium', 'WAF_Large', 'Standard_v2', 'WAF_v2'

serializedName

serializedName: string = "ApplicationGatewaySku"

Optional tier

Tier of an application gateway. Possible values include: 'Standard', 'WAF', 'Standard_v2', 'WAF_v2'

type

type: object

className

className: string = "ApplicationGatewaySku"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

capacity

capacity: object

serializedName

serializedName: string = "capacity"

type

type: object

name

name: "Number" = "Number"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

tier

tier: object

serializedName

serializedName: string = "tier"

type

type: object

name

name: "String" = "String"

Const ApplicationGatewaySslCertificate

ApplicationGatewaySslCertificate: object

SSL certificates of an application gateway.

Optional data

data: undefined | string

Base-64 encoded pfx certificate. Only applicable in PUT Request.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional keyVaultSecretId

keyVaultSecretId: undefined | string

Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault.

Optional name

name: undefined | string

Name of the SSL certificate that is unique within an Application Gateway.

Optional password

password: undefined | string

Password for the pfx file specified in data. Only applicable in PUT request.

Optional provisioningState

provisioningState: undefined | string

Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'.

Optional publicCertData

publicCertData: undefined | string

Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request.

serializedName

serializedName: string = "ApplicationGatewaySslCertificate"

type

type: object

Type of the resource.

className

className: string = "ApplicationGatewaySslCertificate"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

data

data: object

serializedName

serializedName: string = "properties.data"

type

type: object

name

name: "String" = "String"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

keyVaultSecretId

keyVaultSecretId: object

serializedName

serializedName: string = "properties.keyVaultSecretId"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

password

password: object

serializedName

serializedName: string = "properties.password"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

publicCertData

publicCertData: object

serializedName

serializedName: string = "properties.publicCertData"

type

type: object

name

name: "String" = "String"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const ApplicationGatewaySslPolicy

ApplicationGatewaySslPolicy: object

Application Gateway Ssl policy.

Optional cipherSuites

Ssl cipher suites to be enabled in the specified order to application gateway.

Optional disabledSslProtocols

disabledSslProtocols: ApplicationGatewaySslProtocol[]

Ssl protocols to be disabled on application gateway.

Optional minProtocolVersion

minProtocolVersion: ApplicationGatewaySslProtocol

Minimum version of Ssl protocol to be supported on application gateway. Possible values include: 'TLSv1_0', 'TLSv1_1', 'TLSv1_2'

Optional policyName

Name of Ssl predefined policy. Possible values include: 'AppGwSslPolicy20150501', 'AppGwSslPolicy20170401', 'AppGwSslPolicy20170401S'

Optional policyType

Type of Ssl Policy. Possible values include: 'Predefined', 'Custom'

serializedName

serializedName: string = "ApplicationGatewaySslPolicy"

type

type: object

className

className: string = "ApplicationGatewaySslPolicy"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

cipherSuites

cipherSuites: object

serializedName

serializedName: string = "cipherSuites"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

disabledSslProtocols

disabledSslProtocols: object

serializedName

serializedName: string = "disabledSslProtocols"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

minProtocolVersion

minProtocolVersion: object

serializedName

serializedName: string = "minProtocolVersion"

type

type: object

name

name: "String" = "String"

policyName

policyName: object

serializedName

serializedName: string = "policyName"

type

type: object

name

name: "String" = "String"

policyType

policyType: object

serializedName

serializedName: string = "policyType"

type

type: object

name

name: "String" = "String"

Const ApplicationGatewaySslPredefinedPolicy

ApplicationGatewaySslPredefinedPolicy: object

An Ssl predefined policy.

Optional cipherSuites

Ssl cipher suites to be enabled in the specified order for application gateway.

Optional id

id: undefined | string

Resource ID.

Optional minProtocolVersion

minProtocolVersion: ApplicationGatewaySslProtocol

Minimum version of Ssl protocol to be supported on application gateway. Possible values include: 'TLSv1_0', 'TLSv1_1', 'TLSv1_2'

Optional name

name: undefined | string

Name of the Ssl predefined policy.

serializedName

serializedName: string = "ApplicationGatewaySslPredefinedPolicy"

type

type: object

className

className: string = "ApplicationGatewaySslPredefinedPolicy"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

cipherSuites

cipherSuites: object

serializedName

serializedName: string = "properties.cipherSuites"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

minProtocolVersion

minProtocolVersion: object

serializedName

serializedName: string = "properties.minProtocolVersion"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const ApplicationGatewayTrustedRootCertificate

ApplicationGatewayTrustedRootCertificate: object

Trusted Root certificates of an application gateway.

Optional data

data: undefined | string

Certificate public data.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional keyVaultSecretId

keyVaultSecretId: undefined | string

Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault.

Optional name

name: undefined | string

Name of the trusted root certificate that is unique within an Application Gateway.

Optional provisioningState

provisioningState: undefined | string

Provisioning state of the trusted root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

serializedName

serializedName: string = "ApplicationGatewayTrustedRootCertificate"

type

type: object

Type of the resource.

className

className: string = "ApplicationGatewayTrustedRootCertificate"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

data

data: object

serializedName

serializedName: string = "properties.data"

type

type: object

name

name: "String" = "String"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

keyVaultSecretId

keyVaultSecretId: object

serializedName

serializedName: string = "properties.keyVaultSecretId"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const ApplicationGatewayUrlPathMap

ApplicationGatewayUrlPathMap: object

UrlPathMaps give a url path to the backend mapping information for PathBasedRouting.

Optional defaultBackendAddressPool

defaultBackendAddressPool: SubResource

Default backend address pool resource of URL path map.

Optional defaultBackendHttpSettings

defaultBackendHttpSettings: SubResource

Default backend http settings resource of URL path map.

Optional defaultRedirectConfiguration

defaultRedirectConfiguration: SubResource

Default redirect configuration resource of URL path map.

Optional defaultRewriteRuleSet

defaultRewriteRuleSet: SubResource

Default Rewrite rule set resource of URL path map.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

Name of the URL path map that is unique within an Application Gateway.

Optional pathRules

pathRules: ApplicationGatewayPathRule[]

Path rule of URL path map resource.

Optional provisioningState

provisioningState: undefined | string

Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

serializedName

serializedName: string = "ApplicationGatewayUrlPathMap"

type

type: object

Type of the resource.

className

className: string = "ApplicationGatewayUrlPathMap"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

defaultBackendAddressPool

defaultBackendAddressPool: object

serializedName

serializedName: string = "properties.defaultBackendAddressPool"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

defaultBackendHttpSettings

defaultBackendHttpSettings: object

serializedName

serializedName: string = "properties.defaultBackendHttpSettings"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

defaultRedirectConfiguration

defaultRedirectConfiguration: object

serializedName

serializedName: string = "properties.defaultRedirectConfiguration"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

defaultRewriteRuleSet

defaultRewriteRuleSet: object

serializedName

serializedName: string = "properties.defaultRewriteRuleSet"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

pathRules

pathRules: object

serializedName

serializedName: string = "properties.pathRules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationGatewayPathRule"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const ApplicationGatewayWebApplicationFirewallConfiguration

ApplicationGatewayWebApplicationFirewallConfiguration: object

Application gateway web application firewall configuration.

Optional disabledRuleGroups

disabledRuleGroups: ApplicationGatewayFirewallDisabledRuleGroup[]

The disabled rule groups.

enabled

enabled: boolean

Whether the web application firewall is enabled or not.

Optional exclusions

exclusions: ApplicationGatewayFirewallExclusion[]

The exclusion list.

Optional fileUploadLimitInMb

fileUploadLimitInMb: undefined | number

Maximum file upload size in Mb for WAF.

firewallMode

Web application firewall mode. Possible values include: 'Detection', 'Prevention'

Optional maxRequestBodySize

maxRequestBodySize: undefined | number

Maximum request body size for WAF.

Optional maxRequestBodySizeInKb

maxRequestBodySizeInKb: undefined | number

Maximum request body size in Kb for WAF.

Optional requestBodyCheck

requestBodyCheck: undefined | false | true

Whether allow WAF to check request Body.

ruleSetType

ruleSetType: string

The type of the web application firewall rule set. Possible values are: 'OWASP'.

ruleSetVersion

ruleSetVersion: string

The version of the rule set type.

serializedName

serializedName: string = "ApplicationGatewayWebApplicationFirewallConfiguration"

type

type: object

className

className: string = "ApplicationGatewayWebApplicationFirewallConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

disabledRuleGroups

disabledRuleGroups: object

serializedName

serializedName: string = "disabledRuleGroups"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationGatewayFirewallDisabledRuleGroup"

name

name: "Composite" = "Composite"

enabled

enabled: object

required

required: true = true

serializedName

serializedName: string = "enabled"

type

type: object

name

name: "Boolean" = "Boolean"

exclusions

exclusions: object

serializedName

serializedName: string = "exclusions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationGatewayFirewallExclusion"

name

name: "Composite" = "Composite"

fileUploadLimitInMb

fileUploadLimitInMb: object

serializedName

serializedName: string = "fileUploadLimitInMb"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: "Number" = "Number"

firewallMode

firewallMode: object

required

required: true = true

serializedName

serializedName: string = "firewallMode"

type

type: object

name

name: "String" = "String"

maxRequestBodySize

maxRequestBodySize: object

serializedName

serializedName: string = "maxRequestBodySize"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 128

InclusiveMinimum

InclusiveMinimum: number = 8

type

type: object

name

name: "Number" = "Number"

maxRequestBodySizeInKb

maxRequestBodySizeInKb: object

serializedName

serializedName: string = "maxRequestBodySizeInKb"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 128

InclusiveMinimum

InclusiveMinimum: number = 8

type

type: object

name

name: "Number" = "Number"

requestBodyCheck

requestBodyCheck: object

serializedName

serializedName: string = "requestBodyCheck"

type

type: object

name

name: "Boolean" = "Boolean"

ruleSetType

ruleSetType: object

required

required: true = true

serializedName

serializedName: string = "ruleSetType"

type

type: object

name

name: "String" = "String"

ruleSetVersion

ruleSetVersion: object

required

required: true = true

serializedName

serializedName: string = "ruleSetVersion"

type

type: object

name

name: "String" = "String"

Const ApplicationSecurityGroup

ApplicationSecurityGroup: object

An application security group in a resource group.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the application security group resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceGuid

resourceGuid: undefined | string

The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ApplicationSecurityGroup"

Optional tags

tags: undefined | object

Resource tags.

type

type: object

className

className: string = "ApplicationSecurityGroup"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

etag

etag: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

resourceGuid

resourceGuid: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.resourceGuid"

type

type: object

name

name: "String" = "String"

Const ApplicationSecurityGroupListResult

ApplicationSecurityGroupListResult: object
interface

A list of application security groups.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ApplicationSecurityGroupListResult"

__@iterator

  • __@iterator(): IterableIterator<ApplicationSecurityGroup>
  • Iterator

    Returns IterableIterator<ApplicationSecurityGroup>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ApplicationSecurityGroup>[]): ApplicationSecurityGroup[]
  • concat(...items: (T | ConcatArray<T>)[]): ApplicationSecurityGroup[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ApplicationSecurityGroup>[]

      Additional items to add to the end of array1.

    Returns ApplicationSecurityGroup[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ApplicationSecurityGroup[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ApplicationSecurityGroup]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ApplicationSecurityGroup]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ApplicationSecurityGroup, index: number, array: ApplicationSecurityGroup[]): boolean
        • Parameters

          • value: ApplicationSecurityGroup
          • index: number
          • array: ApplicationSecurityGroup[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ApplicationSecurityGroup, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ApplicationSecurityGroup

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ApplicationSecurityGroup[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ApplicationSecurityGroup

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ApplicationSecurityGroup, index: number, array: ApplicationSecurityGroup[]): boolean
        • Parameters

          • value: ApplicationSecurityGroup
          • index: number
          • array: ApplicationSecurityGroup[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ApplicationSecurityGroup, index: number, array: ApplicationSecurityGroup[]): any
        • Parameters

          • value: ApplicationSecurityGroup
          • index: number
          • array: ApplicationSecurityGroup[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ApplicationSecurityGroup[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ApplicationSecurityGroup | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ApplicationSecurityGroup

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ApplicationSecurityGroup, index: number, obj: ApplicationSecurityGroup[]): boolean
        • Parameters

          • this: void
          • value: ApplicationSecurityGroup
          • index: number
          • obj: ApplicationSecurityGroup[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ApplicationSecurityGroup, index: number, obj: ApplicationSecurityGroup[]): boolean
        • Parameters

          • value: ApplicationSecurityGroup
          • index: number
          • obj: ApplicationSecurityGroup[]

          Returns boolean

    • Optional thisArg: any

    Returns ApplicationSecurityGroup | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ApplicationSecurityGroup, index: number, obj: ApplicationSecurityGroup[]): boolean
        • Parameters

          • value: ApplicationSecurityGroup
          • index: number
          • obj: ApplicationSecurityGroup[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ApplicationSecurityGroup, index: number, array: ApplicationSecurityGroup[]): void
        • Parameters

          • value: ApplicationSecurityGroup
          • index: number
          • array: ApplicationSecurityGroup[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ApplicationSecurityGroup, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ApplicationSecurityGroup

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ApplicationSecurityGroup, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ApplicationSecurityGroup

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ApplicationSecurityGroup, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ApplicationSecurityGroup

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ApplicationSecurityGroup, index: number, array: ApplicationSecurityGroup[]): U
        • Parameters

          • value: ApplicationSecurityGroup
          • index: number
          • array: ApplicationSecurityGroup[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ApplicationSecurityGroup | undefined
  • Removes the last element from an array and returns it.

    Returns ApplicationSecurityGroup | undefined

push

  • push(...items: ApplicationSecurityGroup[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ApplicationSecurityGroup[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ApplicationSecurityGroup
  • reduce(callbackfn: function, initialValue: ApplicationSecurityGroup): ApplicationSecurityGroup
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ApplicationSecurityGroup, currentValue: ApplicationSecurityGroup, currentIndex: number, array: ApplicationSecurityGroup[]): ApplicationSecurityGroup
        • Parameters

          • previousValue: ApplicationSecurityGroup
          • currentValue: ApplicationSecurityGroup
          • currentIndex: number
          • array: ApplicationSecurityGroup[]

          Returns ApplicationSecurityGroup

    Returns ApplicationSecurityGroup

  • Parameters

    • callbackfn: function
        • (previousValue: ApplicationSecurityGroup, currentValue: ApplicationSecurityGroup, currentIndex: number, array: ApplicationSecurityGroup[]): ApplicationSecurityGroup
        • Parameters

          • previousValue: ApplicationSecurityGroup
          • currentValue: ApplicationSecurityGroup
          • currentIndex: number
          • array: ApplicationSecurityGroup[]

          Returns ApplicationSecurityGroup

    • initialValue: ApplicationSecurityGroup

    Returns ApplicationSecurityGroup

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ApplicationSecurityGroup, currentIndex: number, array: ApplicationSecurityGroup[]): U
        • Parameters

          • previousValue: U
          • currentValue: ApplicationSecurityGroup
          • currentIndex: number
          • array: ApplicationSecurityGroup[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ApplicationSecurityGroup
  • reduceRight(callbackfn: function, initialValue: ApplicationSecurityGroup): ApplicationSecurityGroup
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ApplicationSecurityGroup, currentValue: ApplicationSecurityGroup, currentIndex: number, array: ApplicationSecurityGroup[]): ApplicationSecurityGroup
        • Parameters

          • previousValue: ApplicationSecurityGroup
          • currentValue: ApplicationSecurityGroup
          • currentIndex: number
          • array: ApplicationSecurityGroup[]

          Returns ApplicationSecurityGroup

    Returns ApplicationSecurityGroup

  • Parameters

    • callbackfn: function
        • (previousValue: ApplicationSecurityGroup, currentValue: ApplicationSecurityGroup, currentIndex: number, array: ApplicationSecurityGroup[]): ApplicationSecurityGroup
        • Parameters

          • previousValue: ApplicationSecurityGroup
          • currentValue: ApplicationSecurityGroup
          • currentIndex: number
          • array: ApplicationSecurityGroup[]

          Returns ApplicationSecurityGroup

    • initialValue: ApplicationSecurityGroup

    Returns ApplicationSecurityGroup

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ApplicationSecurityGroup, currentIndex: number, array: ApplicationSecurityGroup[]): U
        • Parameters

          • previousValue: U
          • currentValue: ApplicationSecurityGroup
          • currentIndex: number
          • array: ApplicationSecurityGroup[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ApplicationSecurityGroup[]
  • Reverses the elements in an Array.

    Returns ApplicationSecurityGroup[]

shift

  • shift(): ApplicationSecurityGroup | undefined
  • Removes the first element from an array and returns it.

    Returns ApplicationSecurityGroup | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ApplicationSecurityGroup[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ApplicationSecurityGroup[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ApplicationSecurityGroup, index: number, array: ApplicationSecurityGroup[]): boolean
        • Parameters

          • value: ApplicationSecurityGroup
          • index: number
          • array: ApplicationSecurityGroup[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ApplicationSecurityGroup[]
  • splice(start: number, deleteCount: number, ...items: ApplicationSecurityGroup[]): ApplicationSecurityGroup[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ApplicationSecurityGroup[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ApplicationSecurityGroup[]

      Elements to insert into the array in place of the deleted elements.

    Returns ApplicationSecurityGroup[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ApplicationSecurityGroup[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ApplicationSecurityGroup[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ApplicationSecurityGroup>
  • Returns an iterable of values in the array

    Returns IterableIterator<ApplicationSecurityGroup>

type

type: object

className

className: string = "ApplicationSecurityGroupListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationSecurityGroup"

name

name: "Composite" = "Composite"

Const AuthorizationListResult

AuthorizationListResult: object
interface

Response for ListAuthorizations API service call retrieves all authorizations that belongs to an ExpressRouteCircuit.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "AuthorizationListResult"

__@iterator

  • __@iterator(): IterableIterator<ExpressRouteCircuitAuthorization>
  • Iterator

    Returns IterableIterator<ExpressRouteCircuitAuthorization>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ExpressRouteCircuitAuthorization>[]): ExpressRouteCircuitAuthorization[]
  • concat(...items: (T | ConcatArray<T>)[]): ExpressRouteCircuitAuthorization[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ExpressRouteCircuitAuthorization>[]

      Additional items to add to the end of array1.

    Returns ExpressRouteCircuitAuthorization[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ExpressRouteCircuitAuthorization[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ExpressRouteCircuitAuthorization]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ExpressRouteCircuitAuthorization]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ExpressRouteCircuitAuthorization, index: number, array: ExpressRouteCircuitAuthorization[]): boolean
        • Parameters

          • value: ExpressRouteCircuitAuthorization
          • index: number
          • array: ExpressRouteCircuitAuthorization[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ExpressRouteCircuitAuthorization, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ExpressRouteCircuitAuthorization

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ExpressRouteCircuitAuthorization[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ExpressRouteCircuitAuthorization

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ExpressRouteCircuitAuthorization, index: number, array: ExpressRouteCircuitAuthorization[]): boolean
        • Parameters

          • value: ExpressRouteCircuitAuthorization
          • index: number
          • array: ExpressRouteCircuitAuthorization[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ExpressRouteCircuitAuthorization, index: number, array: ExpressRouteCircuitAuthorization[]): any
        • Parameters

          • value: ExpressRouteCircuitAuthorization
          • index: number
          • array: ExpressRouteCircuitAuthorization[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ExpressRouteCircuitAuthorization[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ExpressRouteCircuitAuthorization | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ExpressRouteCircuitAuthorization

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ExpressRouteCircuitAuthorization, index: number, obj: ExpressRouteCircuitAuthorization[]): boolean
        • Parameters

          • this: void
          • value: ExpressRouteCircuitAuthorization
          • index: number
          • obj: ExpressRouteCircuitAuthorization[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ExpressRouteCircuitAuthorization, index: number, obj: ExpressRouteCircuitAuthorization[]): boolean
        • Parameters

          • value: ExpressRouteCircuitAuthorization
          • index: number
          • obj: ExpressRouteCircuitAuthorization[]

          Returns boolean

    • Optional thisArg: any

    Returns ExpressRouteCircuitAuthorization | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ExpressRouteCircuitAuthorization, index: number, obj: ExpressRouteCircuitAuthorization[]): boolean
        • Parameters

          • value: ExpressRouteCircuitAuthorization
          • index: number
          • obj: ExpressRouteCircuitAuthorization[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ExpressRouteCircuitAuthorization, index: number, array: ExpressRouteCircuitAuthorization[]): void
        • Parameters

          • value: ExpressRouteCircuitAuthorization
          • index: number
          • array: ExpressRouteCircuitAuthorization[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ExpressRouteCircuitAuthorization, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ExpressRouteCircuitAuthorization

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ExpressRouteCircuitAuthorization, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ExpressRouteCircuitAuthorization

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ExpressRouteCircuitAuthorization, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ExpressRouteCircuitAuthorization

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ExpressRouteCircuitAuthorization, index: number, array: ExpressRouteCircuitAuthorization[]): U
        • Parameters

          • value: ExpressRouteCircuitAuthorization
          • index: number
          • array: ExpressRouteCircuitAuthorization[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ExpressRouteCircuitAuthorization | undefined
  • Removes the last element from an array and returns it.

    Returns ExpressRouteCircuitAuthorization | undefined

push

  • push(...items: ExpressRouteCircuitAuthorization[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ExpressRouteCircuitAuthorization[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ExpressRouteCircuitAuthorization
  • reduce(callbackfn: function, initialValue: ExpressRouteCircuitAuthorization): ExpressRouteCircuitAuthorization
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ExpressRouteCircuitAuthorization, currentValue: ExpressRouteCircuitAuthorization, currentIndex: number, array: ExpressRouteCircuitAuthorization[]): ExpressRouteCircuitAuthorization
        • Parameters

          • previousValue: ExpressRouteCircuitAuthorization
          • currentValue: ExpressRouteCircuitAuthorization
          • currentIndex: number
          • array: ExpressRouteCircuitAuthorization[]

          Returns ExpressRouteCircuitAuthorization

    Returns ExpressRouteCircuitAuthorization

  • Parameters

    • callbackfn: function
        • (previousValue: ExpressRouteCircuitAuthorization, currentValue: ExpressRouteCircuitAuthorization, currentIndex: number, array: ExpressRouteCircuitAuthorization[]): ExpressRouteCircuitAuthorization
        • Parameters

          • previousValue: ExpressRouteCircuitAuthorization
          • currentValue: ExpressRouteCircuitAuthorization
          • currentIndex: number
          • array: ExpressRouteCircuitAuthorization[]

          Returns ExpressRouteCircuitAuthorization

    • initialValue: ExpressRouteCircuitAuthorization

    Returns ExpressRouteCircuitAuthorization

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ExpressRouteCircuitAuthorization, currentIndex: number, array: ExpressRouteCircuitAuthorization[]): U
        • Parameters

          • previousValue: U
          • currentValue: ExpressRouteCircuitAuthorization
          • currentIndex: number
          • array: ExpressRouteCircuitAuthorization[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ExpressRouteCircuitAuthorization
  • reduceRight(callbackfn: function, initialValue: ExpressRouteCircuitAuthorization): ExpressRouteCircuitAuthorization
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ExpressRouteCircuitAuthorization, currentValue: ExpressRouteCircuitAuthorization, currentIndex: number, array: ExpressRouteCircuitAuthorization[]): ExpressRouteCircuitAuthorization
        • Parameters

          • previousValue: ExpressRouteCircuitAuthorization
          • currentValue: ExpressRouteCircuitAuthorization
          • currentIndex: number
          • array: ExpressRouteCircuitAuthorization[]

          Returns ExpressRouteCircuitAuthorization

    Returns ExpressRouteCircuitAuthorization

  • Parameters

    • callbackfn: function
        • (previousValue: ExpressRouteCircuitAuthorization, currentValue: ExpressRouteCircuitAuthorization, currentIndex: number, array: ExpressRouteCircuitAuthorization[]): ExpressRouteCircuitAuthorization
        • Parameters

          • previousValue: ExpressRouteCircuitAuthorization
          • currentValue: ExpressRouteCircuitAuthorization
          • currentIndex: number
          • array: ExpressRouteCircuitAuthorization[]

          Returns ExpressRouteCircuitAuthorization

    • initialValue: ExpressRouteCircuitAuthorization

    Returns ExpressRouteCircuitAuthorization

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ExpressRouteCircuitAuthorization, currentIndex: number, array: ExpressRouteCircuitAuthorization[]): U
        • Parameters

          • previousValue: U
          • currentValue: ExpressRouteCircuitAuthorization
          • currentIndex: number
          • array: ExpressRouteCircuitAuthorization[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ExpressRouteCircuitAuthorization[]
  • Reverses the elements in an Array.

    Returns ExpressRouteCircuitAuthorization[]

shift

  • shift(): ExpressRouteCircuitAuthorization | undefined
  • Removes the first element from an array and returns it.

    Returns ExpressRouteCircuitAuthorization | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ExpressRouteCircuitAuthorization[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ExpressRouteCircuitAuthorization[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ExpressRouteCircuitAuthorization, index: number, array: ExpressRouteCircuitAuthorization[]): boolean
        • Parameters

          • value: ExpressRouteCircuitAuthorization
          • index: number
          • array: ExpressRouteCircuitAuthorization[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ExpressRouteCircuitAuthorization[]
  • splice(start: number, deleteCount: number, ...items: ExpressRouteCircuitAuthorization[]): ExpressRouteCircuitAuthorization[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ExpressRouteCircuitAuthorization[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ExpressRouteCircuitAuthorization[]

      Elements to insert into the array in place of the deleted elements.

    Returns ExpressRouteCircuitAuthorization[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ExpressRouteCircuitAuthorization[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ExpressRouteCircuitAuthorization[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ExpressRouteCircuitAuthorization>
  • Returns an iterable of values in the array

    Returns IterableIterator<ExpressRouteCircuitAuthorization>

type

type: object

className

className: string = "AuthorizationListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ExpressRouteCircuitAuthorization"

name

name: "Composite" = "Composite"

Const Availability

Availability: object

Availability of the metric.

Optional blobDuration

blobDuration: undefined | string

Duration of the availability blob.

Optional retention

retention: undefined | string

The retention of the availability.

serializedName

serializedName: string = "Availability"

Optional timeGrain

timeGrain: undefined | string

The time grain of the availability.

type

type: object

className

className: string = "Availability"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

blobDuration

blobDuration: object

serializedName

serializedName: string = "blobDuration"

type

type: object

name

name: "String" = "String"

retention

retention: object

serializedName

serializedName: string = "retention"

type

type: object

name

name: "String" = "String"

timeGrain

timeGrain: object

serializedName

serializedName: string = "timeGrain"

type

type: object

name

name: "String" = "String"

Const AvailableDelegation

AvailableDelegation: object

The serviceName of an AvailableDelegation indicates a possible delegation for a subnet.

Optional actions

actions: string[]

Describes the actions permitted to the service upon delegation.

Optional id

id: undefined | string

A unique identifier of the AvailableDelegation resource.

Optional name

name: undefined | string

The name of the AvailableDelegation resource.

serializedName

serializedName: string = "AvailableDelegation"

Optional serviceName

serviceName: undefined | string

The name of the service and resource.

type

type: object

Resource type.

className

className: string = "AvailableDelegation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

actions

actions: object

serializedName

serializedName: string = "actions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

serviceName

serviceName: object

serializedName

serializedName: string = "serviceName"

type

type: object

name

name: "String" = "String"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const AvailableDelegationsResult

AvailableDelegationsResult: object
interface

An array of available delegations.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "AvailableDelegationsResult"

__@iterator

  • __@iterator(): IterableIterator<AvailableDelegation>
  • Iterator

    Returns IterableIterator<AvailableDelegation>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<AvailableDelegation>[]): AvailableDelegation[]
  • concat(...items: (T | ConcatArray<T>)[]): AvailableDelegation[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<AvailableDelegation>[]

      Additional items to add to the end of array1.

    Returns AvailableDelegation[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns AvailableDelegation[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, AvailableDelegation]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, AvailableDelegation]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: AvailableDelegation, index: number, array: AvailableDelegation[]): boolean
        • Parameters

          • value: AvailableDelegation
          • index: number
          • array: AvailableDelegation[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: AvailableDelegation, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: AvailableDelegation

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): AvailableDelegation[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: AvailableDelegation

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: AvailableDelegation, index: number, array: AvailableDelegation[]): boolean
        • Parameters

          • value: AvailableDelegation
          • index: number
          • array: AvailableDelegation[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: AvailableDelegation, index: number, array: AvailableDelegation[]): any
        • Parameters

          • value: AvailableDelegation
          • index: number
          • array: AvailableDelegation[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns AvailableDelegation[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): AvailableDelegation | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: AvailableDelegation

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: AvailableDelegation, index: number, obj: AvailableDelegation[]): boolean
        • Parameters

          • this: void
          • value: AvailableDelegation
          • index: number
          • obj: AvailableDelegation[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: AvailableDelegation, index: number, obj: AvailableDelegation[]): boolean
        • Parameters

          • value: AvailableDelegation
          • index: number
          • obj: AvailableDelegation[]

          Returns boolean

    • Optional thisArg: any

    Returns AvailableDelegation | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: AvailableDelegation, index: number, obj: AvailableDelegation[]): boolean
        • Parameters

          • value: AvailableDelegation
          • index: number
          • obj: AvailableDelegation[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: AvailableDelegation, index: number, array: AvailableDelegation[]): void
        • Parameters

          • value: AvailableDelegation
          • index: number
          • array: AvailableDelegation[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: AvailableDelegation, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: AvailableDelegation

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: AvailableDelegation, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: AvailableDelegation

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: AvailableDelegation, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: AvailableDelegation

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: AvailableDelegation, index: number, array: AvailableDelegation[]): U
        • Parameters

          • value: AvailableDelegation
          • index: number
          • array: AvailableDelegation[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): AvailableDelegation | undefined
  • Removes the last element from an array and returns it.

    Returns AvailableDelegation | undefined

push

  • push(...items: AvailableDelegation[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: AvailableDelegation[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): AvailableDelegation
  • reduce(callbackfn: function, initialValue: AvailableDelegation): AvailableDelegation
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: AvailableDelegation, currentValue: AvailableDelegation, currentIndex: number, array: AvailableDelegation[]): AvailableDelegation
        • Parameters

          • previousValue: AvailableDelegation
          • currentValue: AvailableDelegation
          • currentIndex: number
          • array: AvailableDelegation[]

          Returns AvailableDelegation

    Returns AvailableDelegation

  • Parameters

    • callbackfn: function
        • (previousValue: AvailableDelegation, currentValue: AvailableDelegation, currentIndex: number, array: AvailableDelegation[]): AvailableDelegation
        • Parameters

          • previousValue: AvailableDelegation
          • currentValue: AvailableDelegation
          • currentIndex: number
          • array: AvailableDelegation[]

          Returns AvailableDelegation

    • initialValue: AvailableDelegation

    Returns AvailableDelegation

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: AvailableDelegation, currentIndex: number, array: AvailableDelegation[]): U
        • Parameters

          • previousValue: U
          • currentValue: AvailableDelegation
          • currentIndex: number
          • array: AvailableDelegation[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): AvailableDelegation
  • reduceRight(callbackfn: function, initialValue: AvailableDelegation): AvailableDelegation
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: AvailableDelegation, currentValue: AvailableDelegation, currentIndex: number, array: AvailableDelegation[]): AvailableDelegation
        • Parameters

          • previousValue: AvailableDelegation
          • currentValue: AvailableDelegation
          • currentIndex: number
          • array: AvailableDelegation[]

          Returns AvailableDelegation

    Returns AvailableDelegation

  • Parameters

    • callbackfn: function
        • (previousValue: AvailableDelegation, currentValue: AvailableDelegation, currentIndex: number, array: AvailableDelegation[]): AvailableDelegation
        • Parameters

          • previousValue: AvailableDelegation
          • currentValue: AvailableDelegation
          • currentIndex: number
          • array: AvailableDelegation[]

          Returns AvailableDelegation

    • initialValue: AvailableDelegation

    Returns AvailableDelegation

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: AvailableDelegation, currentIndex: number, array: AvailableDelegation[]): U
        • Parameters

          • previousValue: U
          • currentValue: AvailableDelegation
          • currentIndex: number
          • array: AvailableDelegation[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): AvailableDelegation[]
  • Reverses the elements in an Array.

    Returns AvailableDelegation[]

shift

  • shift(): AvailableDelegation | undefined
  • Removes the first element from an array and returns it.

    Returns AvailableDelegation | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): AvailableDelegation[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns AvailableDelegation[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: AvailableDelegation, index: number, array: AvailableDelegation[]): boolean
        • Parameters

          • value: AvailableDelegation
          • index: number
          • array: AvailableDelegation[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): AvailableDelegation[]
  • splice(start: number, deleteCount: number, ...items: AvailableDelegation[]): AvailableDelegation[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns AvailableDelegation[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: AvailableDelegation[]

      Elements to insert into the array in place of the deleted elements.

    Returns AvailableDelegation[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: AvailableDelegation[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: AvailableDelegation[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<AvailableDelegation>
  • Returns an iterable of values in the array

    Returns IterableIterator<AvailableDelegation>

type

type: object

className

className: string = "AvailableDelegationsResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AvailableDelegation"

name

name: "Composite" = "Composite"

Const AvailablePrivateEndpointType

AvailablePrivateEndpointType: object

The information of an AvailablePrivateEndpointType.

Optional id

id: undefined | string

A unique identifier of the AvailablePrivateEndpoint Type resource.

serializedName

serializedName: string = "AvailablePrivateEndpointType"

Optional serviceName

serviceName: undefined | string

The name of the service and resource.

type

type: object

Resource type.

className

className: string = "AvailablePrivateEndpointType"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

serviceName

serviceName: object

serializedName

serializedName: string = "serviceName"

type

type: object

name

name: "String" = "String"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const AvailablePrivateEndpointTypesResult

AvailablePrivateEndpointTypesResult: object
interface

An array of available PrivateEndpoint types.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "AvailablePrivateEndpointTypesResult"

__@iterator

  • __@iterator(): IterableIterator<AvailablePrivateEndpointType>
  • Iterator

    Returns IterableIterator<AvailablePrivateEndpointType>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<AvailablePrivateEndpointType>[]): AvailablePrivateEndpointType[]
  • concat(...items: (T | ConcatArray<T>)[]): AvailablePrivateEndpointType[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<AvailablePrivateEndpointType>[]

      Additional items to add to the end of array1.

    Returns AvailablePrivateEndpointType[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns AvailablePrivateEndpointType[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, AvailablePrivateEndpointType]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, AvailablePrivateEndpointType]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: AvailablePrivateEndpointType, index: number, array: AvailablePrivateEndpointType[]): boolean
        • Parameters

          • value: AvailablePrivateEndpointType
          • index: number
          • array: AvailablePrivateEndpointType[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: AvailablePrivateEndpointType, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: AvailablePrivateEndpointType

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): AvailablePrivateEndpointType[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: AvailablePrivateEndpointType

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: AvailablePrivateEndpointType, index: number, array: AvailablePrivateEndpointType[]): boolean
        • Parameters

          • value: AvailablePrivateEndpointType
          • index: number
          • array: AvailablePrivateEndpointType[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: AvailablePrivateEndpointType, index: number, array: AvailablePrivateEndpointType[]): any
        • Parameters

          • value: AvailablePrivateEndpointType
          • index: number
          • array: AvailablePrivateEndpointType[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns AvailablePrivateEndpointType[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): AvailablePrivateEndpointType | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: AvailablePrivateEndpointType

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: AvailablePrivateEndpointType, index: number, obj: AvailablePrivateEndpointType[]): boolean
        • Parameters

          • this: void
          • value: AvailablePrivateEndpointType
          • index: number
          • obj: AvailablePrivateEndpointType[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: AvailablePrivateEndpointType, index: number, obj: AvailablePrivateEndpointType[]): boolean
        • Parameters

          • value: AvailablePrivateEndpointType
          • index: number
          • obj: AvailablePrivateEndpointType[]

          Returns boolean

    • Optional thisArg: any

    Returns AvailablePrivateEndpointType | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: AvailablePrivateEndpointType, index: number, obj: AvailablePrivateEndpointType[]): boolean
        • Parameters

          • value: AvailablePrivateEndpointType
          • index: number
          • obj: AvailablePrivateEndpointType[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: AvailablePrivateEndpointType, index: number, array: AvailablePrivateEndpointType[]): void
        • Parameters

          • value: AvailablePrivateEndpointType
          • index: number
          • array: AvailablePrivateEndpointType[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: AvailablePrivateEndpointType, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: AvailablePrivateEndpointType

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: AvailablePrivateEndpointType, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: AvailablePrivateEndpointType

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: AvailablePrivateEndpointType, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: AvailablePrivateEndpointType

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: AvailablePrivateEndpointType, index: number, array: AvailablePrivateEndpointType[]): U
        • Parameters

          • value: AvailablePrivateEndpointType
          • index: number
          • array: AvailablePrivateEndpointType[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): AvailablePrivateEndpointType | undefined
  • Removes the last element from an array and returns it.

    Returns AvailablePrivateEndpointType | undefined

push

  • push(...items: AvailablePrivateEndpointType[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: AvailablePrivateEndpointType[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): AvailablePrivateEndpointType
  • reduce(callbackfn: function, initialValue: AvailablePrivateEndpointType): AvailablePrivateEndpointType
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: AvailablePrivateEndpointType, currentValue: AvailablePrivateEndpointType, currentIndex: number, array: AvailablePrivateEndpointType[]): AvailablePrivateEndpointType
        • Parameters

          • previousValue: AvailablePrivateEndpointType
          • currentValue: AvailablePrivateEndpointType
          • currentIndex: number
          • array: AvailablePrivateEndpointType[]

          Returns AvailablePrivateEndpointType

    Returns AvailablePrivateEndpointType

  • Parameters

    • callbackfn: function
        • (previousValue: AvailablePrivateEndpointType, currentValue: AvailablePrivateEndpointType, currentIndex: number, array: AvailablePrivateEndpointType[]): AvailablePrivateEndpointType
        • Parameters

          • previousValue: AvailablePrivateEndpointType
          • currentValue: AvailablePrivateEndpointType
          • currentIndex: number
          • array: AvailablePrivateEndpointType[]

          Returns AvailablePrivateEndpointType

    • initialValue: AvailablePrivateEndpointType

    Returns AvailablePrivateEndpointType

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: AvailablePrivateEndpointType, currentIndex: number, array: AvailablePrivateEndpointType[]): U
        • Parameters

          • previousValue: U
          • currentValue: AvailablePrivateEndpointType
          • currentIndex: number
          • array: AvailablePrivateEndpointType[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): AvailablePrivateEndpointType
  • reduceRight(callbackfn: function, initialValue: AvailablePrivateEndpointType): AvailablePrivateEndpointType
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: AvailablePrivateEndpointType, currentValue: AvailablePrivateEndpointType, currentIndex: number, array: AvailablePrivateEndpointType[]): AvailablePrivateEndpointType
        • Parameters

          • previousValue: AvailablePrivateEndpointType
          • currentValue: AvailablePrivateEndpointType
          • currentIndex: number
          • array: AvailablePrivateEndpointType[]

          Returns AvailablePrivateEndpointType

    Returns AvailablePrivateEndpointType

  • Parameters

    • callbackfn: function
        • (previousValue: AvailablePrivateEndpointType, currentValue: AvailablePrivateEndpointType, currentIndex: number, array: AvailablePrivateEndpointType[]): AvailablePrivateEndpointType
        • Parameters

          • previousValue: AvailablePrivateEndpointType
          • currentValue: AvailablePrivateEndpointType
          • currentIndex: number
          • array: AvailablePrivateEndpointType[]

          Returns AvailablePrivateEndpointType

    • initialValue: AvailablePrivateEndpointType

    Returns AvailablePrivateEndpointType

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: AvailablePrivateEndpointType, currentIndex: number, array: AvailablePrivateEndpointType[]): U
        • Parameters

          • previousValue: U
          • currentValue: AvailablePrivateEndpointType
          • currentIndex: number
          • array: AvailablePrivateEndpointType[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): AvailablePrivateEndpointType[]
  • Reverses the elements in an Array.

    Returns AvailablePrivateEndpointType[]

shift

  • shift(): AvailablePrivateEndpointType | undefined
  • Removes the first element from an array and returns it.

    Returns AvailablePrivateEndpointType | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): AvailablePrivateEndpointType[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns AvailablePrivateEndpointType[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: AvailablePrivateEndpointType, index: number, array: AvailablePrivateEndpointType[]): boolean
        • Parameters

          • value: AvailablePrivateEndpointType
          • index: number
          • array: AvailablePrivateEndpointType[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): AvailablePrivateEndpointType[]
  • splice(start: number, deleteCount: number, ...items: AvailablePrivateEndpointType[]): AvailablePrivateEndpointType[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns AvailablePrivateEndpointType[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: AvailablePrivateEndpointType[]

      Elements to insert into the array in place of the deleted elements.

    Returns AvailablePrivateEndpointType[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: AvailablePrivateEndpointType[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: AvailablePrivateEndpointType[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<AvailablePrivateEndpointType>
  • Returns an iterable of values in the array

    Returns IterableIterator<AvailablePrivateEndpointType>

type

type: object

className

className: string = "AvailablePrivateEndpointTypesResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AvailablePrivateEndpointType"

name

name: "Composite" = "Composite"

Const AvailableProvidersList

AvailableProvidersList: object

List of available countries with details.

countries

countries: AvailableProvidersListCountry[]

List of available countries.

serializedName

serializedName: string = "AvailableProvidersList"

type

type: object

className

className: string = "AvailableProvidersList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

countries

countries: object

required

required: true = true

serializedName

serializedName: string = "countries"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AvailableProvidersListCountry"

name

name: "Composite" = "Composite"

Const AvailableProvidersListCity

AvailableProvidersListCity: object

City or town details.

Optional cityName

cityName: undefined | string

The city or town name.

Optional providers

providers: string[]

A list of Internet service providers.

serializedName

serializedName: string = "AvailableProvidersListCity"

type

type: object

className

className: string = "AvailableProvidersListCity"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

cityName

cityName: object

serializedName

serializedName: string = "cityName"

type

type: object

name

name: "String" = "String"

providers

providers: object

serializedName

serializedName: string = "providers"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const AvailableProvidersListCountry

AvailableProvidersListCountry: object

Country details.

Optional countryName

countryName: undefined | string

The country name.

Optional providers

providers: string[]

A list of Internet service providers.

serializedName

serializedName: string = "AvailableProvidersListCountry"

Optional states

states: AvailableProvidersListState[]

List of available states in the country.

type

type: object

className

className: string = "AvailableProvidersListCountry"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

countryName

countryName: object

serializedName

serializedName: string = "countryName"

type

type: object

name

name: "String" = "String"

providers

providers: object

serializedName

serializedName: string = "providers"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

states

states: object

serializedName

serializedName: string = "states"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AvailableProvidersListState"

name

name: "Composite" = "Composite"

Const AvailableProvidersListParameters

AvailableProvidersListParameters: object

Constraints that determine the list of available Internet service providers.

Optional azureLocations

azureLocations: string[]

A list of Azure regions.

Optional city

city: undefined | string

The city or town for available providers list.

Optional country

country: undefined | string

The country for available providers list.

serializedName

serializedName: string = "AvailableProvidersListParameters"

Optional state

state: undefined | string

The state for available providers list.

type

type: object

className

className: string = "AvailableProvidersListParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

azureLocations

azureLocations: object

serializedName

serializedName: string = "azureLocations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

city

city: object

serializedName

serializedName: string = "city"

type

type: object

name

name: "String" = "String"

country

country: object

serializedName

serializedName: string = "country"

type

type: object

name

name: "String" = "String"

state

state: object

serializedName

serializedName: string = "state"

type

type: object

name

name: "String" = "String"

Const AvailableProvidersListState

AvailableProvidersListState: object

State details.

Optional cities

cities: AvailableProvidersListCity[]

List of available cities or towns in the state.

Optional providers

providers: string[]

A list of Internet service providers.

serializedName

serializedName: string = "AvailableProvidersListState"

Optional stateName

stateName: undefined | string

The state name.

type

type: object

className

className: string = "AvailableProvidersListState"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

cities

cities: object

serializedName

serializedName: string = "cities"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AvailableProvidersListCity"

name

name: "Composite" = "Composite"

providers

providers: object

serializedName

serializedName: string = "providers"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

stateName

stateName: object

serializedName

serializedName: string = "stateName"

type

type: object

name

name: "String" = "String"

Const AzureAsyncOperationResult

AzureAsyncOperationResult: object

The response body contains the status of the specified asynchronous operation, indicating whether it has succeeded, is in progress, or has failed. Note that this status is distinct from the HTTP status code returned for the Get Operation Status operation itself. If the asynchronous operation succeeded, the response body includes the HTTP status code for the successful request. If the asynchronous operation failed, the response body includes the HTTP status code for the failed request and error information regarding the failure.

Optional error

error: ErrorModel

Details of the error occurred during specified asynchronous operation.

serializedName

serializedName: string = "AzureAsyncOperationResult"

Optional status

Status of the Azure async operation. Possible values include: 'InProgress', 'Succeeded', 'Failed'

type

type: object

className

className: string = "AzureAsyncOperationResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

error

error: object

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "ErrorModel"

name

name: "Composite" = "Composite"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

Const AzureFirewall

AzureFirewall: object

Azure Firewall resource.

Optional applicationRuleCollections

applicationRuleCollections: AzureFirewallApplicationRuleCollection[]

Collection of application rule collections used by Azure Firewall.

Optional etag

etag: undefined | string

Gets a unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID.

Optional ipConfigurations

ipConfigurations: AzureFirewallIPConfiguration[]

IP configuration of the Azure Firewall resource.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional natRuleCollections

natRuleCollections: AzureFirewallNatRuleCollection[]

Collection of NAT rule collections used by Azure Firewall.

Optional networkRuleCollections

networkRuleCollections: AzureFirewallNetworkRuleCollection[]

Collection of network rule collections used by Azure Firewall.

Optional provisioningState

provisioningState: ProvisioningState

The provisioning state of the resource. Possible values include: 'Succeeded', 'Updating', 'Deleting', 'Failed'

serializedName

serializedName: string = "AzureFirewall"

Optional tags

tags: undefined | object

Resource tags.

Optional threatIntelMode

The operation mode for Threat Intelligence. Possible values include: 'Alert', 'Deny', 'Off'

Optional zones

zones: string[]

A list of availability zones denoting where the resource needs to come from.

type

type: object

className

className: string = "AzureFirewall"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicationRuleCollections

applicationRuleCollections: object

serializedName

serializedName: string = "properties.applicationRuleCollections"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AzureFirewallApplicationRuleCollection"

name

name: "Composite" = "Composite"

etag

etag: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

ipConfigurations

ipConfigurations: object

serializedName

serializedName: string = "properties.ipConfigurations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AzureFirewallIPConfiguration"

name

name: "Composite" = "Composite"

natRuleCollections

natRuleCollections: object

serializedName

serializedName: string = "properties.natRuleCollections"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AzureFirewallNatRuleCollection"

name

name: "Composite" = "Composite"

networkRuleCollections

networkRuleCollections: object

serializedName

serializedName: string = "properties.networkRuleCollections"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AzureFirewallNetworkRuleCollection"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

threatIntelMode

threatIntelMode: object

serializedName

serializedName: string = "properties.threatIntelMode"

type

type: object

name

name: "String" = "String"

zones

zones: object

serializedName

serializedName: string = "zones"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const AzureFirewallApplicationRule

AzureFirewallApplicationRule: object

Properties of an application rule.

Optional description

description: undefined | string

Description of the rule.

Optional fqdnTags

fqdnTags: string[]

List of FQDN Tags for this rule.

Optional name

name: undefined | string

Name of the application rule.

Optional protocols

protocols: AzureFirewallApplicationRuleProtocol[]

Array of ApplicationRuleProtocols.

serializedName

serializedName: string = "AzureFirewallApplicationRule"

Optional sourceAddresses

sourceAddresses: string[]

List of source IP addresses for this rule.

Optional targetFqdns

targetFqdns: string[]

List of FQDNs for this rule.

type

type: object

className

className: string = "AzureFirewallApplicationRule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "String" = "String"

fqdnTags

fqdnTags: object

serializedName

serializedName: string = "fqdnTags"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

protocols

protocols: object

serializedName

serializedName: string = "protocols"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AzureFirewallApplicationRuleProtocol"

name

name: "Composite" = "Composite"

sourceAddresses

sourceAddresses: object

serializedName

serializedName: string = "sourceAddresses"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

targetFqdns

targetFqdns: object

serializedName

serializedName: string = "targetFqdns"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const AzureFirewallApplicationRuleCollection

AzureFirewallApplicationRuleCollection: object

Application rule collection resource.

Optional action

The action type of a rule collection.

Optional etag

etag: undefined | string

Gets a unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

Gets name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional priority

priority: undefined | number

Priority of the application rule collection resource.

Optional provisioningState

provisioningState: ProvisioningState

The provisioning state of the resource. Possible values include: 'Succeeded', 'Updating', 'Deleting', 'Failed'

Optional rules

rules: AzureFirewallApplicationRule[]

Collection of rules used by a application rule collection.

serializedName

serializedName: string = "AzureFirewallApplicationRuleCollection"

type

type: object

className

className: string = "AzureFirewallApplicationRuleCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

action

action: object

serializedName

serializedName: string = "properties.action"

type

type: object

className

className: string = "AzureFirewallRCAction"

name

name: "Composite" = "Composite"

etag

etag: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

priority

priority: object

serializedName

serializedName: string = "properties.priority"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 65000

InclusiveMinimum

InclusiveMinimum: number = 100

type

type: object

name

name: "Number" = "Number"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

rules

rules: object

serializedName

serializedName: string = "properties.rules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AzureFirewallApplicationRule"

name

name: "Composite" = "Composite"

Const AzureFirewallApplicationRuleProtocol

AzureFirewallApplicationRuleProtocol: object

Properties of the application rule protocol.

Optional port

port: undefined | number

Port number for the protocol, cannot be greater than 64000. This field is optional.

Optional protocolType

Protocol type. Possible values include: 'Http', 'Https'

serializedName

serializedName: string = "AzureFirewallApplicationRuleProtocol"

type

type: object

className

className: string = "AzureFirewallApplicationRuleProtocol"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

port

port: object

serializedName

serializedName: string = "port"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 64000

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: "Number" = "Number"

protocolType

protocolType: object

serializedName

serializedName: string = "protocolType"

type

type: object

name

name: "String" = "String"

Const AzureFirewallFqdnTag

AzureFirewallFqdnTag: object

Azure Firewall FQDN Tag Resource.

Optional etag

etag: undefined | string

Gets a unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

Optional fqdnTagName

fqdnTagName: undefined | string

The name of this FQDN Tag. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "AzureFirewallFqdnTag"

Optional tags

tags: undefined | object

Resource tags.

type

type: object

className

className: string = "AzureFirewallFqdnTag"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

etag

etag: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

fqdnTagName

fqdnTagName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.fqdnTagName"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

Const AzureFirewallFqdnTagListResult

AzureFirewallFqdnTagListResult: object
interface

Response for ListAzureFirewallFqdnTags API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

URL to get the next set of results.

serializedName

serializedName: string = "AzureFirewallFqdnTagListResult"

__@iterator

  • __@iterator(): IterableIterator<AzureFirewallFqdnTag>
  • Iterator

    Returns IterableIterator<AzureFirewallFqdnTag>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<AzureFirewallFqdnTag>[]): AzureFirewallFqdnTag[]
  • concat(...items: (T | ConcatArray<T>)[]): AzureFirewallFqdnTag[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<AzureFirewallFqdnTag>[]

      Additional items to add to the end of array1.

    Returns AzureFirewallFqdnTag[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns AzureFirewallFqdnTag[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, AzureFirewallFqdnTag]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, AzureFirewallFqdnTag]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: AzureFirewallFqdnTag, index: number, array: AzureFirewallFqdnTag[]): boolean
        • Parameters

          • value: AzureFirewallFqdnTag
          • index: number
          • array: AzureFirewallFqdnTag[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: AzureFirewallFqdnTag, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: AzureFirewallFqdnTag

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): AzureFirewallFqdnTag[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: AzureFirewallFqdnTag

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: AzureFirewallFqdnTag, index: number, array: AzureFirewallFqdnTag[]): boolean
        • Parameters

          • value: AzureFirewallFqdnTag
          • index: number
          • array: AzureFirewallFqdnTag[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: AzureFirewallFqdnTag, index: number, array: AzureFirewallFqdnTag[]): any
        • Parameters

          • value: AzureFirewallFqdnTag
          • index: number
          • array: AzureFirewallFqdnTag[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns AzureFirewallFqdnTag[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): AzureFirewallFqdnTag | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: AzureFirewallFqdnTag

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: AzureFirewallFqdnTag, index: number, obj: AzureFirewallFqdnTag[]): boolean
        • Parameters

          • this: void
          • value: AzureFirewallFqdnTag
          • index: number
          • obj: AzureFirewallFqdnTag[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: AzureFirewallFqdnTag, index: number, obj: AzureFirewallFqdnTag[]): boolean
        • Parameters

          • value: AzureFirewallFqdnTag
          • index: number
          • obj: AzureFirewallFqdnTag[]

          Returns boolean

    • Optional thisArg: any

    Returns AzureFirewallFqdnTag | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: AzureFirewallFqdnTag, index: number, obj: AzureFirewallFqdnTag[]): boolean
        • Parameters

          • value: AzureFirewallFqdnTag
          • index: number
          • obj: AzureFirewallFqdnTag[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: AzureFirewallFqdnTag, index: number, array: AzureFirewallFqdnTag[]): void
        • Parameters

          • value: AzureFirewallFqdnTag
          • index: number
          • array: AzureFirewallFqdnTag[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: AzureFirewallFqdnTag, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: AzureFirewallFqdnTag

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: AzureFirewallFqdnTag, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: AzureFirewallFqdnTag

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: AzureFirewallFqdnTag, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: AzureFirewallFqdnTag

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: AzureFirewallFqdnTag, index: number, array: AzureFirewallFqdnTag[]): U
        • Parameters

          • value: AzureFirewallFqdnTag
          • index: number
          • array: AzureFirewallFqdnTag[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): AzureFirewallFqdnTag | undefined
  • Removes the last element from an array and returns it.

    Returns AzureFirewallFqdnTag | undefined

push

  • push(...items: AzureFirewallFqdnTag[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: AzureFirewallFqdnTag[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): AzureFirewallFqdnTag
  • reduce(callbackfn: function, initialValue: AzureFirewallFqdnTag): AzureFirewallFqdnTag
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: AzureFirewallFqdnTag, currentValue: AzureFirewallFqdnTag, currentIndex: number, array: AzureFirewallFqdnTag[]): AzureFirewallFqdnTag
        • Parameters

          • previousValue: AzureFirewallFqdnTag
          • currentValue: AzureFirewallFqdnTag
          • currentIndex: number
          • array: AzureFirewallFqdnTag[]

          Returns AzureFirewallFqdnTag

    Returns AzureFirewallFqdnTag

  • Parameters

    • callbackfn: function
        • (previousValue: AzureFirewallFqdnTag, currentValue: AzureFirewallFqdnTag, currentIndex: number, array: AzureFirewallFqdnTag[]): AzureFirewallFqdnTag
        • Parameters

          • previousValue: AzureFirewallFqdnTag
          • currentValue: AzureFirewallFqdnTag
          • currentIndex: number
          • array: AzureFirewallFqdnTag[]

          Returns AzureFirewallFqdnTag

    • initialValue: AzureFirewallFqdnTag

    Returns AzureFirewallFqdnTag

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: AzureFirewallFqdnTag, currentIndex: number, array: AzureFirewallFqdnTag[]): U
        • Parameters

          • previousValue: U
          • currentValue: AzureFirewallFqdnTag
          • currentIndex: number
          • array: AzureFirewallFqdnTag[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): AzureFirewallFqdnTag
  • reduceRight(callbackfn: function, initialValue: AzureFirewallFqdnTag): AzureFirewallFqdnTag
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: AzureFirewallFqdnTag, currentValue: AzureFirewallFqdnTag, currentIndex: number, array: AzureFirewallFqdnTag[]): AzureFirewallFqdnTag
        • Parameters

          • previousValue: AzureFirewallFqdnTag
          • currentValue: AzureFirewallFqdnTag
          • currentIndex: number
          • array: AzureFirewallFqdnTag[]

          Returns AzureFirewallFqdnTag

    Returns AzureFirewallFqdnTag

  • Parameters

    • callbackfn: function
        • (previousValue: AzureFirewallFqdnTag, currentValue: AzureFirewallFqdnTag, currentIndex: number, array: AzureFirewallFqdnTag[]): AzureFirewallFqdnTag
        • Parameters

          • previousValue: AzureFirewallFqdnTag
          • currentValue: AzureFirewallFqdnTag
          • currentIndex: number
          • array: AzureFirewallFqdnTag[]

          Returns AzureFirewallFqdnTag

    • initialValue: AzureFirewallFqdnTag

    Returns AzureFirewallFqdnTag

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: AzureFirewallFqdnTag, currentIndex: number, array: AzureFirewallFqdnTag[]): U
        • Parameters

          • previousValue: U
          • currentValue: AzureFirewallFqdnTag
          • currentIndex: number
          • array: AzureFirewallFqdnTag[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): AzureFirewallFqdnTag[]
  • Reverses the elements in an Array.

    Returns AzureFirewallFqdnTag[]

shift

  • shift(): AzureFirewallFqdnTag | undefined
  • Removes the first element from an array and returns it.

    Returns AzureFirewallFqdnTag | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): AzureFirewallFqdnTag[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns AzureFirewallFqdnTag[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: AzureFirewallFqdnTag, index: number, array: AzureFirewallFqdnTag[]): boolean
        • Parameters

          • value: AzureFirewallFqdnTag
          • index: number
          • array: AzureFirewallFqdnTag[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): AzureFirewallFqdnTag[]
  • splice(start: number, deleteCount: number, ...items: AzureFirewallFqdnTag[]): AzureFirewallFqdnTag[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns AzureFirewallFqdnTag[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: AzureFirewallFqdnTag[]

      Elements to insert into the array in place of the deleted elements.

    Returns AzureFirewallFqdnTag[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: AzureFirewallFqdnTag[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: AzureFirewallFqdnTag[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<AzureFirewallFqdnTag>
  • Returns an iterable of values in the array

    Returns IterableIterator<AzureFirewallFqdnTag>

type

type: object

className

className: string = "AzureFirewallFqdnTagListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AzureFirewallFqdnTag"

name

name: "Composite" = "Composite"

Const AzureFirewallIPConfiguration

AzureFirewallIPConfiguration: object

IP configuration of an Azure Firewall.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

Name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional privateIPAddress

privateIPAddress: undefined | string

The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: ProvisioningState

The provisioning state of the resource. Possible values include: 'Succeeded', 'Updating', 'Deleting', 'Failed'

Optional publicIPAddress

publicIPAddress: SubResource

Reference of the PublicIP resource. This field is a mandatory input if subnet is not null.

serializedName

serializedName: string = "AzureFirewallIPConfiguration"

Optional subnet

subnet: SubResource

Reference of the subnet resource. This resource must be named 'AzureFirewallSubnet'.

type

type: object

className

className: string = "AzureFirewallIPConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

etag

etag: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

privateIPAddress

privateIPAddress: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.privateIPAddress"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

publicIPAddress

publicIPAddress: object

serializedName

serializedName: string = "properties.publicIPAddress"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

subnet

subnet: object

serializedName

serializedName: string = "properties.subnet"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

Const AzureFirewallListResult

AzureFirewallListResult: object
interface

Response for ListAzureFirewalls API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

URL to get the next set of results.

serializedName

serializedName: string = "AzureFirewallListResult"

__@iterator

  • __@iterator(): IterableIterator<AzureFirewall>
  • Iterator

    Returns IterableIterator<AzureFirewall>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<AzureFirewall>[]): AzureFirewall[]
  • concat(...items: (T | ConcatArray<T>)[]): AzureFirewall[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<AzureFirewall>[]

      Additional items to add to the end of array1.

    Returns AzureFirewall[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns AzureFirewall[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, AzureFirewall]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, AzureFirewall]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: AzureFirewall, index: number, array: AzureFirewall[]): boolean
        • Parameters

          • value: AzureFirewall
          • index: number
          • array: AzureFirewall[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: AzureFirewall, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: AzureFirewall

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): AzureFirewall[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: AzureFirewall

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: AzureFirewall, index: number, array: AzureFirewall[]): boolean
        • Parameters

          • value: AzureFirewall
          • index: number
          • array: AzureFirewall[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: AzureFirewall, index: number, array: AzureFirewall[]): any
        • Parameters

          • value: AzureFirewall
          • index: number
          • array: AzureFirewall[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns AzureFirewall[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): AzureFirewall | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: AzureFirewall

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: AzureFirewall, index: number, obj: AzureFirewall[]): boolean
        • Parameters

          • this: void
          • value: AzureFirewall
          • index: number
          • obj: AzureFirewall[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: AzureFirewall, index: number, obj: AzureFirewall[]): boolean
        • Parameters

          • value: AzureFirewall
          • index: number
          • obj: AzureFirewall[]

          Returns boolean

    • Optional thisArg: any

    Returns AzureFirewall | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: AzureFirewall, index: number, obj: AzureFirewall[]): boolean
        • Parameters

          • value: AzureFirewall
          • index: number
          • obj: AzureFirewall[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: AzureFirewall, index: number, array: AzureFirewall[]): void
        • Parameters

          • value: AzureFirewall
          • index: number
          • array: AzureFirewall[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: AzureFirewall, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: AzureFirewall

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: AzureFirewall, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: AzureFirewall

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: AzureFirewall, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: AzureFirewall

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: AzureFirewall, index: number, array: AzureFirewall[]): U
        • Parameters

          • value: AzureFirewall
          • index: number
          • array: AzureFirewall[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): AzureFirewall | undefined
  • Removes the last element from an array and returns it.

    Returns AzureFirewall | undefined

push

  • push(...items: AzureFirewall[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: AzureFirewall[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): AzureFirewall
  • reduce(callbackfn: function, initialValue: AzureFirewall): AzureFirewall
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: AzureFirewall, currentValue: AzureFirewall, currentIndex: number, array: AzureFirewall[]): AzureFirewall
        • Parameters

          • previousValue: AzureFirewall
          • currentValue: AzureFirewall
          • currentIndex: number
          • array: AzureFirewall[]

          Returns AzureFirewall

    Returns AzureFirewall

  • Parameters

    • callbackfn: function
        • (previousValue: AzureFirewall, currentValue: AzureFirewall, currentIndex: number, array: AzureFirewall[]): AzureFirewall
        • Parameters

          • previousValue: AzureFirewall
          • currentValue: AzureFirewall
          • currentIndex: number
          • array: AzureFirewall[]

          Returns AzureFirewall

    • initialValue: AzureFirewall

    Returns AzureFirewall

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: AzureFirewall, currentIndex: number, array: AzureFirewall[]): U
        • Parameters

          • previousValue: U
          • currentValue: AzureFirewall
          • currentIndex: number
          • array: AzureFirewall[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): AzureFirewall
  • reduceRight(callbackfn: function, initialValue: AzureFirewall): AzureFirewall
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: AzureFirewall, currentValue: AzureFirewall, currentIndex: number, array: AzureFirewall[]): AzureFirewall
        • Parameters

          • previousValue: AzureFirewall
          • currentValue: AzureFirewall
          • currentIndex: number
          • array: AzureFirewall[]

          Returns AzureFirewall

    Returns AzureFirewall

  • Parameters

    • callbackfn: function
        • (previousValue: AzureFirewall, currentValue: AzureFirewall, currentIndex: number, array: AzureFirewall[]): AzureFirewall
        • Parameters

          • previousValue: AzureFirewall
          • currentValue: AzureFirewall
          • currentIndex: number
          • array: AzureFirewall[]

          Returns AzureFirewall

    • initialValue: AzureFirewall

    Returns AzureFirewall

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: AzureFirewall, currentIndex: number, array: AzureFirewall[]): U
        • Parameters

          • previousValue: U
          • currentValue: AzureFirewall
          • currentIndex: number
          • array: AzureFirewall[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): AzureFirewall[]
  • Reverses the elements in an Array.

    Returns AzureFirewall[]

shift

  • shift(): AzureFirewall | undefined
  • Removes the first element from an array and returns it.

    Returns AzureFirewall | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): AzureFirewall[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns AzureFirewall[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: AzureFirewall, index: number, array: AzureFirewall[]): boolean
        • Parameters

          • value: AzureFirewall
          • index: number
          • array: AzureFirewall[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): AzureFirewall[]
  • splice(start: number, deleteCount: number, ...items: AzureFirewall[]): AzureFirewall[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns AzureFirewall[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: AzureFirewall[]

      Elements to insert into the array in place of the deleted elements.

    Returns AzureFirewall[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: AzureFirewall[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: AzureFirewall[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<AzureFirewall>
  • Returns an iterable of values in the array

    Returns IterableIterator<AzureFirewall>

type

type: object

className

className: string = "AzureFirewallListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AzureFirewall"

name

name: "Composite" = "Composite"

Const AzureFirewallNatRCAction

AzureFirewallNatRCAction: object

AzureFirewall NAT Rule Collection Action.

serializedName

serializedName: string = "AzureFirewallNatRCAction"

type

type: object

The type of action. Possible values include: 'Snat', 'Dnat'

className

className: string = "AzureFirewallNatRCAction"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const AzureFirewallNatRule

AzureFirewallNatRule: object

Properties of a NAT rule.

Optional description

description: undefined | string

Description of the rule.

Optional destinationAddresses

destinationAddresses: string[]

List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags.

Optional destinationPorts

destinationPorts: string[]

List of destination ports.

Optional name

name: undefined | string

Name of the NAT rule.

Optional protocols

Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule.

serializedName

serializedName: string = "AzureFirewallNatRule"

Optional sourceAddresses

sourceAddresses: string[]

List of source IP addresses for this rule.

Optional translatedAddress

translatedAddress: undefined | string

The translated address for this NAT rule.

Optional translatedPort

translatedPort: undefined | string

The translated port for this NAT rule.

type

type: object

className

className: string = "AzureFirewallNatRule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "String" = "String"

destinationAddresses

destinationAddresses: object

serializedName

serializedName: string = "destinationAddresses"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

destinationPorts

destinationPorts: object

serializedName

serializedName: string = "destinationPorts"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

protocols

protocols: object

serializedName

serializedName: string = "protocols"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

sourceAddresses

sourceAddresses: object

serializedName

serializedName: string = "sourceAddresses"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

translatedAddress

translatedAddress: object

serializedName

serializedName: string = "translatedAddress"

type

type: object

name

name: "String" = "String"

translatedPort

translatedPort: object

serializedName

serializedName: string = "translatedPort"

type

type: object

name

name: "String" = "String"

Const AzureFirewallNatRuleCollection

AzureFirewallNatRuleCollection: object

NAT rule collection resource.

Optional action

The action type of a NAT rule collection.

Optional etag

etag: undefined | string

Gets a unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

Gets name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional priority

priority: undefined | number

Priority of the NAT rule collection resource.

Optional provisioningState

provisioningState: ProvisioningState

The provisioning state of the resource. Possible values include: 'Succeeded', 'Updating', 'Deleting', 'Failed'

Optional rules

rules: AzureFirewallNatRule[]

Collection of rules used by a NAT rule collection.

serializedName

serializedName: string = "AzureFirewallNatRuleCollection"

type

type: object

className

className: string = "AzureFirewallNatRuleCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

action

action: object

serializedName

serializedName: string = "properties.action"

type

type: object

className

className: string = "AzureFirewallNatRCAction"

name

name: "Composite" = "Composite"

etag

etag: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

priority

priority: object

serializedName

serializedName: string = "properties.priority"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 65000

InclusiveMinimum

InclusiveMinimum: number = 100

type

type: object

name

name: "Number" = "Number"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

rules

rules: object

serializedName

serializedName: string = "properties.rules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AzureFirewallNatRule"

name

name: "Composite" = "Composite"

Const AzureFirewallNetworkRule

AzureFirewallNetworkRule: object

Properties of the network rule.

Optional description

description: undefined | string

Description of the rule.

Optional destinationAddresses

destinationAddresses: string[]

List of destination IP addresses.

Optional destinationPorts

destinationPorts: string[]

List of destination ports.

Optional name

name: undefined | string

Name of the network rule.

Optional protocols

Array of AzureFirewallNetworkRuleProtocols.

serializedName

serializedName: string = "AzureFirewallNetworkRule"

Optional sourceAddresses

sourceAddresses: string[]

List of source IP addresses for this rule.

type

type: object

className

className: string = "AzureFirewallNetworkRule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "String" = "String"

destinationAddresses

destinationAddresses: object

serializedName

serializedName: string = "destinationAddresses"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

destinationPorts

destinationPorts: object

serializedName

serializedName: string = "destinationPorts"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

protocols

protocols: object

serializedName

serializedName: string = "protocols"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

sourceAddresses

sourceAddresses: object

serializedName

serializedName: string = "sourceAddresses"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const AzureFirewallNetworkRuleCollection

AzureFirewallNetworkRuleCollection: object

Network rule collection resource.

Optional action

The action type of a rule collection.

Optional etag

etag: undefined | string

Gets a unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

Gets name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional priority

priority: undefined | number

Priority of the network rule collection resource.

Optional provisioningState

provisioningState: ProvisioningState

The provisioning state of the resource. Possible values include: 'Succeeded', 'Updating', 'Deleting', 'Failed'

Optional rules

rules: AzureFirewallNetworkRule[]

Collection of rules used by a network rule collection.

serializedName

serializedName: string = "AzureFirewallNetworkRuleCollection"

type

type: object

className

className: string = "AzureFirewallNetworkRuleCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

action

action: object

serializedName

serializedName: string = "properties.action"

type

type: object

className

className: string = "AzureFirewallRCAction"

name

name: "Composite" = "Composite"

etag

etag: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

priority

priority: object

serializedName

serializedName: string = "properties.priority"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 65000

InclusiveMinimum

InclusiveMinimum: number = 100

type

type: object

name

name: "Number" = "Number"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

rules

rules: object

serializedName

serializedName: string = "properties.rules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AzureFirewallNetworkRule"

name

name: "Composite" = "Composite"

Const AzureFirewallRCAction

AzureFirewallRCAction: object

Properties of the AzureFirewallRCAction.

serializedName

serializedName: string = "AzureFirewallRCAction"

type

type: object

The type of action. Possible values include: 'Allow', 'Deny'

className

className: string = "AzureFirewallRCAction"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const AzureReachabilityReport

AzureReachabilityReport: object

Azure reachability report details.

aggregationLevel

aggregationLevel: string

The aggregation level of Azure reachability report. Can be Country, State or City.

providerLocation

providerLocation: AzureReachabilityReportLocation

Parameters that define a geographic location.

reachabilityReport

reachabilityReport: AzureReachabilityReportItem[]

List of Azure reachability report items.

serializedName

serializedName: string = "AzureReachabilityReport"

type

type: object

className

className: string = "AzureReachabilityReport"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

aggregationLevel

aggregationLevel: object

required

required: true = true

serializedName

serializedName: string = "aggregationLevel"

type

type: object

name

name: "String" = "String"

providerLocation

providerLocation: object

required

required: true = true

serializedName

serializedName: string = "providerLocation"

type

type: object

className

className: string = "AzureReachabilityReportLocation"

name

name: "Composite" = "Composite"

reachabilityReport

reachabilityReport: object

required

required: true = true

serializedName

serializedName: string = "reachabilityReport"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AzureReachabilityReportItem"

name

name: "Composite" = "Composite"

Const AzureReachabilityReportItem

AzureReachabilityReportItem: object

Azure reachability report details for a given provider location.

Optional azureLocation

azureLocation: undefined | string

The Azure region.

Optional latencies

latencies: AzureReachabilityReportLatencyInfo[]

List of latency details for each of the time series.

Optional provider

provider: undefined | string

The Internet service provider.

serializedName

serializedName: string = "AzureReachabilityReportItem"

type

type: object

className

className: string = "AzureReachabilityReportItem"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

azureLocation

azureLocation: object

serializedName

serializedName: string = "azureLocation"

type

type: object

name

name: "String" = "String"

latencies

latencies: object

serializedName

serializedName: string = "latencies"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AzureReachabilityReportLatencyInfo"

name

name: "Composite" = "Composite"

provider

provider: object

serializedName

serializedName: string = "provider"

type

type: object

name

name: "String" = "String"

Const AzureReachabilityReportLatencyInfo

AzureReachabilityReportLatencyInfo: object

Details on latency for a time series.

Optional score

score: undefined | number

The relative latency score between 1 and 100, higher values indicating a faster connection.

serializedName

serializedName: string = "AzureReachabilityReportLatencyInfo"

Optional timeStamp

timeStamp: Date

The time stamp.

type

type: object

className

className: string = "AzureReachabilityReportLatencyInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

score

score: object

serializedName

serializedName: string = "score"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 100

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: "Number" = "Number"

timeStamp

timeStamp: object

serializedName

serializedName: string = "timeStamp"

type

type: object

name

name: "DateTime" = "DateTime"

Const AzureReachabilityReportLocation

AzureReachabilityReportLocation: object

Parameters that define a geographic location.

Optional city

city: undefined | string

The name of the city or town.

country

country: string

The name of the country.

serializedName

serializedName: string = "AzureReachabilityReportLocation"

Optional state

state: undefined | string

The name of the state.

type

type: object

className

className: string = "AzureReachabilityReportLocation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

city

city: object

serializedName

serializedName: string = "city"

type

type: object

name

name: "String" = "String"

country

country: object

required

required: true = true

serializedName

serializedName: string = "country"

type

type: object

name

name: "String" = "String"

state

state: object

serializedName

serializedName: string = "state"

type

type: object

name

name: "String" = "String"

Const AzureReachabilityReportParameters

AzureReachabilityReportParameters: object

Geographic and time constraints for Azure reachability report.

Optional azureLocations

azureLocations: string[]

Optional Azure regions to scope the query to.

endTime

endTime: Date

The end time for the Azure reachability report.

providerLocation

providerLocation: AzureReachabilityReportLocation

Parameters that define a geographic location.

Optional providers

providers: string[]

List of Internet service providers.

serializedName

serializedName: string = "AzureReachabilityReportParameters"

startTime

startTime: Date

The start time for the Azure reachability report.

type

type: object

className

className: string = "AzureReachabilityReportParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

azureLocations

azureLocations: object

serializedName

serializedName: string = "azureLocations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

endTime

endTime: object

required

required: true = true

serializedName

serializedName: string = "endTime"

type

type: object

name

name: "DateTime" = "DateTime"

providerLocation

providerLocation: object

required

required: true = true

serializedName

serializedName: string = "providerLocation"

type

type: object

className

className: string = "AzureReachabilityReportLocation"

name

name: "Composite" = "Composite"

providers

providers: object

serializedName

serializedName: string = "providers"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

startTime

startTime: object

required

required: true = true

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

Const BGPCommunity

BGPCommunity: object

Contains bgp community information offered in Service Community resources.

Optional communityName

communityName: undefined | string

The name of the bgp community. e.g. Skype.

Optional communityPrefixes

communityPrefixes: string[]

The prefixes that the bgp community contains.

Optional communityValue

communityValue: undefined | string

The value of the bgp community. For more information: https://docs.microsoft.com/en-us/azure/expressroute/expressroute-routing.

Optional isAuthorizedToUse

isAuthorizedToUse: undefined | false | true

Customer is authorized to use bgp community or not.

serializedName

serializedName: string = "BGPCommunity"

Optional serviceGroup

serviceGroup: undefined | string

The service group of the bgp community contains.

Optional serviceSupportedRegion

serviceSupportedRegion: undefined | string

The region which the service support. e.g. For O365, region is Global.

type

type: object

className

className: string = "BGPCommunity"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

communityName

communityName: object

serializedName

serializedName: string = "communityName"

type

type: object

name

name: "String" = "String"

communityPrefixes

communityPrefixes: object

serializedName

serializedName: string = "communityPrefixes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

communityValue

communityValue: object

serializedName

serializedName: string = "communityValue"

type

type: object

name

name: "String" = "String"

isAuthorizedToUse

isAuthorizedToUse: object

serializedName

serializedName: string = "isAuthorizedToUse"

type

type: object

name

name: "Boolean" = "Boolean"

serviceGroup

serviceGroup: object

serializedName

serializedName: string = "serviceGroup"

type

type: object

name

name: "String" = "String"

serviceSupportedRegion

serviceSupportedRegion: object

serializedName

serializedName: string = "serviceSupportedRegion"

type

type: object

name

name: "String" = "String"

Const BackendAddressPool

BackendAddressPool: object

Pool of backend IP addresses.

Optional backendIPConfigurations

backendIPConfigurations: NetworkInterfaceIPConfiguration[]

Gets collection of references to IP addresses defined in network interfaces. NOTE: This property will not be serialized. It can only be populated by the server.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional loadBalancingRules

loadBalancingRules: SubResource[]

Gets load balancing rules that use this backend address pool. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Gets name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional outboundRule

outboundRule: SubResource

Gets outbound rules that use this backend address pool. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string

Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

serializedName

serializedName: string = "BackendAddressPool"

type

type: object

className

className: string = "BackendAddressPool"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backendIPConfigurations

backendIPConfigurations: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.backendIPConfigurations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NetworkInterfaceIPConfiguration"

name

name: "Composite" = "Composite"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

loadBalancingRules

loadBalancingRules: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.loadBalancingRules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

outboundRule

outboundRule: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.outboundRule"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

Const BastionHost

BastionHost: object

Bastion Host resource.

Optional dnsName

dnsName: undefined | string

FQDN for the endpoint on which bastion host is accessible.

Optional etag

etag: undefined | string

Gets a unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID.

Optional ipConfigurations

ipConfigurations: BastionHostIPConfiguration[]

IP configuration of the Bastion Host resource.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: ProvisioningState

The provisioning state of the resource. Possible values include: 'Succeeded', 'Updating', 'Deleting', 'Failed'

serializedName

serializedName: string = "BastionHost"

Optional tags

tags: undefined | object

Resource tags.

type

type: object

className

className: string = "BastionHost"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dnsName

dnsName: object

serializedName

serializedName: string = "properties.dnsName"

type

type: object

name

name: "String" = "String"

etag

etag: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

ipConfigurations

ipConfigurations: object

serializedName

serializedName: string = "properties.ipConfigurations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "BastionHostIPConfiguration"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

Const BastionHostIPConfiguration

BastionHostIPConfiguration: object

IP configuration of an Bastion Host.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

Name of the resource that is unique within a resource group. This name can be used to access the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional privateIPAllocationMethod

privateIPAllocationMethod: IPAllocationMethod

Private IP allocation method. Possible values include: 'Static', 'Dynamic'

Optional provisioningState

provisioningState: ProvisioningState

The provisioning state of the resource. Possible values include: 'Succeeded', 'Updating', 'Deleting', 'Failed'

publicIPAddress

publicIPAddress: SubResource

Reference of the PublicIP resource.

serializedName

serializedName: string = "BastionHostIPConfiguration"

subnet

subnet: SubResource

Reference of the subnet resource.

type

type: object

Ip configuration type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "BastionHostIPConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

etag

etag: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

privateIPAllocationMethod

privateIPAllocationMethod: object

serializedName

serializedName: string = "properties.privateIPAllocationMethod"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

publicIPAddress

publicIPAddress: object

required

required: true = true

serializedName

serializedName: string = "properties.publicIPAddress"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

subnet

subnet: object

required

required: true = true

serializedName

serializedName: string = "properties.subnet"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const BastionHostListResult

BastionHostListResult: object
interface

Response for ListBastionHosts API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

URL to get the next set of results.

serializedName

serializedName: string = "BastionHostListResult"

__@iterator

  • __@iterator(): IterableIterator<BastionHost>
  • Iterator

    Returns IterableIterator<BastionHost>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<BastionHost>[]): BastionHost[]
  • concat(...items: (T | ConcatArray<T>)[]): BastionHost[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<BastionHost>[]

      Additional items to add to the end of array1.

    Returns BastionHost[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns BastionHost[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, BastionHost]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, BastionHost]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: BastionHost, index: number, array: BastionHost[]): boolean
        • Parameters

          • value: BastionHost
          • index: number
          • array: BastionHost[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: BastionHost, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: BastionHost

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): BastionHost[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: BastionHost

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: BastionHost, index: number, array: BastionHost[]): boolean
        • Parameters

          • value: BastionHost
          • index: number
          • array: BastionHost[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: BastionHost, index: number, array: BastionHost[]): any
        • Parameters

          • value: BastionHost
          • index: number
          • array: BastionHost[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns BastionHost[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): BastionHost | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: BastionHost

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: BastionHost, index: number, obj: BastionHost[]): boolean
        • Parameters

          • this: void
          • value: BastionHost
          • index: number
          • obj: BastionHost[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: BastionHost, index: number, obj: BastionHost[]): boolean
        • Parameters

          • value: BastionHost
          • index: number
          • obj: BastionHost[]

          Returns boolean

    • Optional thisArg: any

    Returns BastionHost | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: BastionHost, index: number, obj: BastionHost[]): boolean
        • Parameters

          • value: BastionHost
          • index: number
          • obj: BastionHost[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: BastionHost, index: number, array: BastionHost[]): void
        • Parameters

          • value: BastionHost
          • index: number
          • array: BastionHost[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: BastionHost, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: BastionHost

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: BastionHost, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: BastionHost

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: BastionHost, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: BastionHost

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: BastionHost, index: number, array: BastionHost[]): U
        • Parameters

          • value: BastionHost
          • index: number
          • array: BastionHost[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): BastionHost | undefined
  • Removes the last element from an array and returns it.

    Returns BastionHost | undefined

push

  • push(...items: BastionHost[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: BastionHost[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): BastionHost
  • reduce(callbackfn: function, initialValue: BastionHost): BastionHost
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: BastionHost, currentValue: BastionHost, currentIndex: number, array: BastionHost[]): BastionHost
        • Parameters

          • previousValue: BastionHost
          • currentValue: BastionHost
          • currentIndex: number
          • array: BastionHost[]

          Returns BastionHost

    Returns BastionHost

  • Parameters

    • callbackfn: function
        • (previousValue: BastionHost, currentValue: BastionHost, currentIndex: number, array: BastionHost[]): BastionHost
        • Parameters

          • previousValue: BastionHost
          • currentValue: BastionHost
          • currentIndex: number
          • array: BastionHost[]

          Returns BastionHost

    • initialValue: BastionHost

    Returns BastionHost

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: BastionHost, currentIndex: number, array: BastionHost[]): U
        • Parameters

          • previousValue: U
          • currentValue: BastionHost
          • currentIndex: number
          • array: BastionHost[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): BastionHost
  • reduceRight(callbackfn: function, initialValue: BastionHost): BastionHost
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: BastionHost, currentValue: BastionHost, currentIndex: number, array: BastionHost[]): BastionHost
        • Parameters

          • previousValue: BastionHost
          • currentValue: BastionHost
          • currentIndex: number
          • array: BastionHost[]

          Returns BastionHost

    Returns BastionHost

  • Parameters

    • callbackfn: function
        • (previousValue: BastionHost, currentValue: BastionHost, currentIndex: number, array: BastionHost[]): BastionHost
        • Parameters

          • previousValue: BastionHost
          • currentValue: BastionHost
          • currentIndex: number
          • array: BastionHost[]

          Returns BastionHost

    • initialValue: BastionHost

    Returns BastionHost

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: BastionHost, currentIndex: number, array: BastionHost[]): U
        • Parameters

          • previousValue: U
          • currentValue: BastionHost
          • currentIndex: number
          • array: BastionHost[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): BastionHost[]
  • Reverses the elements in an Array.

    Returns BastionHost[]

shift

  • shift(): BastionHost | undefined
  • Removes the first element from an array and returns it.

    Returns BastionHost | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): BastionHost[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns BastionHost[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: BastionHost, index: number, array: BastionHost[]): boolean
        • Parameters

          • value: BastionHost
          • index: number
          • array: BastionHost[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): BastionHost[]
  • splice(start: number, deleteCount: number, ...items: BastionHost[]): BastionHost[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns BastionHost[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: BastionHost[]

      Elements to insert into the array in place of the deleted elements.

    Returns BastionHost[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: BastionHost[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: BastionHost[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<BastionHost>
  • Returns an iterable of values in the array

    Returns IterableIterator<BastionHost>

type

type: object

className

className: string = "BastionHostListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "BastionHost"

name

name: "Composite" = "Composite"

Const BgpPeerStatus

BgpPeerStatus: object

BGP peer status details.

Optional asn

asn: undefined | number

The autonomous system number of the remote BGP peer. NOTE: This property will not be serialized. It can only be populated by the server.

Optional connectedDuration

connectedDuration: undefined | string

For how long the peering has been up. NOTE: This property will not be serialized. It can only be populated by the server.

Optional localAddress

localAddress: undefined | string

The virtual network gateway's local address. NOTE: This property will not be serialized. It can only be populated by the server.

Optional messagesReceived

messagesReceived: undefined | number

The number of BGP messages received. NOTE: This property will not be serialized. It can only be populated by the server.

Optional messagesSent

messagesSent: undefined | number

The number of BGP messages sent. NOTE: This property will not be serialized. It can only be populated by the server.

Optional neighbor

neighbor: undefined | string

The remote BGP peer. NOTE: This property will not be serialized. It can only be populated by the server.

Optional routesReceived

routesReceived: undefined | number

The number of routes learned from this peer. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "BgpPeerStatus"

Optional state

The BGP peer state. Possible values include: 'Unknown', 'Stopped', 'Idle', 'Connecting', 'Connected' NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "BgpPeerStatus"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

asn

asn: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "asn"

type

type: object

name

name: "Number" = "Number"

connectedDuration

connectedDuration: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "connectedDuration"

type

type: object

name

name: "String" = "String"

localAddress

localAddress: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "localAddress"

type

type: object

name

name: "String" = "String"

messagesReceived

messagesReceived: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "messagesReceived"

type

type: object

name

name: "Number" = "Number"

messagesSent

messagesSent: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "messagesSent"

type

type: object

name

name: "Number" = "Number"

neighbor

neighbor: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "neighbor"

type

type: object

name

name: "String" = "String"

routesReceived

routesReceived: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "routesReceived"

type

type: object

name

name: "Number" = "Number"

state

state: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "state"

type

type: object

name

name: "String" = "String"

Const BgpPeerStatusListResult

BgpPeerStatusListResult: object

Response for list BGP peer status API service call.

serializedName

serializedName: string = "BgpPeerStatusListResult"

Optional value

value: BgpPeerStatus[]

List of BGP peers.

type

type: object

className

className: string = "BgpPeerStatusListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "BgpPeerStatus"

name

name: "Composite" = "Composite"

Const BgpServiceCommunity

BgpServiceCommunity: object

Service Community Properties.

Optional bgpCommunities

bgpCommunities: BGPCommunity[]

Get a list of bgp communities.

Optional id

id: undefined | string

Resource ID.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "BgpServiceCommunity"

Optional serviceName

serviceName: undefined | string

The name of the bgp community. e.g. Skype.

Optional tags

tags: undefined | object

Resource tags.

type

type: object

className

className: string = "BgpServiceCommunity"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

bgpCommunities

bgpCommunities: object

serializedName

serializedName: string = "properties.bgpCommunities"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "BGPCommunity"

name

name: "Composite" = "Composite"

serviceName

serviceName: object

serializedName

serializedName: string = "properties.serviceName"

type

type: object

name

name: "String" = "String"

Const BgpServiceCommunityListResult

BgpServiceCommunityListResult: object
interface

Response for the ListServiceCommunity API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "BgpServiceCommunityListResult"

__@iterator

  • __@iterator(): IterableIterator<BgpServiceCommunity>
  • Iterator

    Returns IterableIterator<BgpServiceCommunity>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<BgpServiceCommunity>[]): BgpServiceCommunity[]
  • concat(...items: (T | ConcatArray<T>)[]): BgpServiceCommunity[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<BgpServiceCommunity>[]

      Additional items to add to the end of array1.

    Returns BgpServiceCommunity[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns BgpServiceCommunity[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, BgpServiceCommunity]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, BgpServiceCommunity]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: BgpServiceCommunity, index: number, array: BgpServiceCommunity[]): boolean
        • Parameters

          • value: BgpServiceCommunity
          • index: number
          • array: BgpServiceCommunity[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: BgpServiceCommunity, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: BgpServiceCommunity

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): BgpServiceCommunity[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: BgpServiceCommunity

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: BgpServiceCommunity, index: number, array: BgpServiceCommunity[]): boolean
        • Parameters

          • value: BgpServiceCommunity
          • index: number
          • array: BgpServiceCommunity[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: BgpServiceCommunity, index: number, array: BgpServiceCommunity[]): any
        • Parameters

          • value: BgpServiceCommunity
          • index: number
          • array: BgpServiceCommunity[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns BgpServiceCommunity[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): BgpServiceCommunity | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: BgpServiceCommunity

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: BgpServiceCommunity, index: number, obj: BgpServiceCommunity[]): boolean
        • Parameters

          • this: void
          • value: BgpServiceCommunity
          • index: number
          • obj: BgpServiceCommunity[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: BgpServiceCommunity, index: number, obj: BgpServiceCommunity[]): boolean
        • Parameters

          • value: BgpServiceCommunity
          • index: number
          • obj: BgpServiceCommunity[]

          Returns boolean

    • Optional thisArg: any

    Returns BgpServiceCommunity | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: BgpServiceCommunity, index: number, obj: BgpServiceCommunity[]): boolean
        • Parameters

          • value: BgpServiceCommunity
          • index: number
          • obj: BgpServiceCommunity[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: BgpServiceCommunity, index: number, array: BgpServiceCommunity[]): void
        • Parameters

          • value: BgpServiceCommunity
          • index: number
          • array: BgpServiceCommunity[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: BgpServiceCommunity, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: BgpServiceCommunity

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: BgpServiceCommunity, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: BgpServiceCommunity

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: BgpServiceCommunity, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: BgpServiceCommunity

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: BgpServiceCommunity, index: number, array: BgpServiceCommunity[]): U
        • Parameters

          • value: BgpServiceCommunity
          • index: number
          • array: BgpServiceCommunity[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): BgpServiceCommunity | undefined
  • Removes the last element from an array and returns it.

    Returns BgpServiceCommunity | undefined

push

  • push(...items: BgpServiceCommunity[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: BgpServiceCommunity[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): BgpServiceCommunity
  • reduce(callbackfn: function, initialValue: BgpServiceCommunity): BgpServiceCommunity
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: BgpServiceCommunity, currentValue: BgpServiceCommunity, currentIndex: number, array: BgpServiceCommunity[]): BgpServiceCommunity
        • Parameters

          • previousValue: BgpServiceCommunity
          • currentValue: BgpServiceCommunity
          • currentIndex: number
          • array: BgpServiceCommunity[]

          Returns BgpServiceCommunity

    Returns BgpServiceCommunity

  • Parameters

    • callbackfn: function
        • (previousValue: BgpServiceCommunity, currentValue: BgpServiceCommunity, currentIndex: number, array: BgpServiceCommunity[]): BgpServiceCommunity
        • Parameters

          • previousValue: BgpServiceCommunity
          • currentValue: BgpServiceCommunity
          • currentIndex: number
          • array: BgpServiceCommunity[]

          Returns BgpServiceCommunity

    • initialValue: BgpServiceCommunity

    Returns BgpServiceCommunity

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: BgpServiceCommunity, currentIndex: number, array: BgpServiceCommunity[]): U
        • Parameters

          • previousValue: U
          • currentValue: BgpServiceCommunity
          • currentIndex: number
          • array: BgpServiceCommunity[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): BgpServiceCommunity
  • reduceRight(callbackfn: function, initialValue: BgpServiceCommunity): BgpServiceCommunity
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: BgpServiceCommunity, currentValue: BgpServiceCommunity, currentIndex: number, array: BgpServiceCommunity[]): BgpServiceCommunity
        • Parameters

          • previousValue: BgpServiceCommunity
          • currentValue: BgpServiceCommunity
          • currentIndex: number
          • array: BgpServiceCommunity[]

          Returns BgpServiceCommunity

    Returns BgpServiceCommunity

  • Parameters

    • callbackfn: function
        • (previousValue: BgpServiceCommunity, currentValue: BgpServiceCommunity, currentIndex: number, array: BgpServiceCommunity[]): BgpServiceCommunity
        • Parameters

          • previousValue: BgpServiceCommunity
          • currentValue: BgpServiceCommunity
          • currentIndex: number
          • array: BgpServiceCommunity[]

          Returns BgpServiceCommunity

    • initialValue: BgpServiceCommunity

    Returns BgpServiceCommunity

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: BgpServiceCommunity, currentIndex: number, array: BgpServiceCommunity[]): U
        • Parameters

          • previousValue: U
          • currentValue: BgpServiceCommunity
          • currentIndex: number
          • array: BgpServiceCommunity[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): BgpServiceCommunity[]
  • Reverses the elements in an Array.

    Returns BgpServiceCommunity[]

shift

  • shift(): BgpServiceCommunity | undefined
  • Removes the first element from an array and returns it.

    Returns BgpServiceCommunity | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): BgpServiceCommunity[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns BgpServiceCommunity[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: BgpServiceCommunity, index: number, array: BgpServiceCommunity[]): boolean
        • Parameters

          • value: BgpServiceCommunity
          • index: number
          • array: BgpServiceCommunity[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): BgpServiceCommunity[]
  • splice(start: number, deleteCount: number, ...items: BgpServiceCommunity[]): BgpServiceCommunity[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns BgpServiceCommunity[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: BgpServiceCommunity[]

      Elements to insert into the array in place of the deleted elements.

    Returns BgpServiceCommunity[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: BgpServiceCommunity[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: BgpServiceCommunity[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<BgpServiceCommunity>
  • Returns an iterable of values in the array

    Returns IterableIterator<BgpServiceCommunity>

type

type: object

className

className: string = "BgpServiceCommunityListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "BgpServiceCommunity"

name

name: "Composite" = "Composite"

Const BgpSettings

BgpSettings: object

BGP settings details.

Optional asn

asn: undefined | number

The BGP speaker's ASN.

Optional bgpPeeringAddress

bgpPeeringAddress: undefined | string

The BGP peering address and BGP identifier of this BGP speaker.

Optional peerWeight

peerWeight: undefined | number

The weight added to routes learned from this BGP speaker.

serializedName

serializedName: string = "BgpSettings"

type

type: object

className

className: string = "BgpSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

asn

asn: object

serializedName

serializedName: string = "asn"

type

type: object

name

name: "Number" = "Number"

bgpPeeringAddress

bgpPeeringAddress: object

serializedName

serializedName: string = "bgpPeeringAddress"

type

type: object

name

name: "String" = "String"

peerWeight

peerWeight: object

serializedName

serializedName: string = "peerWeight"

type

type: object

name

name: "Number" = "Number"

Const ConnectionMonitor

ConnectionMonitor: object

Parameters that define the operation to create a connection monitor.

Optional autoStart

autoStart: undefined | false | true

Determines if the connection monitor will start automatically once created. Default value: true.

destination

destination: ConnectionMonitorDestination

Describes the destination of connection monitor.

Optional location

location: undefined | string

Connection monitor location.

Optional monitoringIntervalInSeconds

monitoringIntervalInSeconds: undefined | number

Monitoring interval in seconds. Default value: 60.

serializedName

serializedName: string = "ConnectionMonitor"

source

source: ConnectionMonitorSource

Describes the source of connection monitor.

Optional tags

tags: undefined | object

Connection monitor tags.

type

type: object

className

className: string = "ConnectionMonitor"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

autoStart

autoStart: object

defaultValue

defaultValue: boolean = true

serializedName

serializedName: string = "properties.autoStart"

type

type: object

name

name: "Boolean" = "Boolean"

destination

destination: object

required

required: true = true

serializedName

serializedName: string = "properties.destination"

type

type: object

className

className: string = "ConnectionMonitorDestination"

name

name: "Composite" = "Composite"

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

monitoringIntervalInSeconds

monitoringIntervalInSeconds: object

defaultValue

defaultValue: number = 60

serializedName

serializedName: string = "properties.monitoringIntervalInSeconds"

type

type: object

name

name: "Number" = "Number"

source

source: object

required

required: true = true

serializedName

serializedName: string = "properties.source"

type

type: object

className

className: string = "ConnectionMonitorSource"

name

name: "Composite" = "Composite"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

Const ConnectionMonitorDestination

ConnectionMonitorDestination: object

Describes the destination of connection monitor.

Optional address

address: undefined | string

Address of the connection monitor destination (IP or domain name).

Optional port

port: undefined | number

The destination port used by connection monitor.

Optional resourceId

resourceId: undefined | string

The ID of the resource used as the destination by connection monitor.

serializedName

serializedName: string = "ConnectionMonitorDestination"

type

type: object

className

className: string = "ConnectionMonitorDestination"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

address

address: object

serializedName

serializedName: string = "address"

type

type: object

name

name: "String" = "String"

port

port: object

serializedName

serializedName: string = "port"

type

type: object

name

name: "Number" = "Number"

resourceId

resourceId: object

serializedName

serializedName: string = "resourceId"

type

type: object

name

name: "String" = "String"

Const ConnectionMonitorListResult

ConnectionMonitorListResult: object
interface

List of connection monitors.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "ConnectionMonitorListResult"

__@iterator

  • __@iterator(): IterableIterator<ConnectionMonitorResult>
  • Iterator

    Returns IterableIterator<ConnectionMonitorResult>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ConnectionMonitorResult>[]): ConnectionMonitorResult[]
  • concat(...items: (T | ConcatArray<T>)[]): ConnectionMonitorResult[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ConnectionMonitorResult>[]

      Additional items to add to the end of array1.

    Returns ConnectionMonitorResult[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ConnectionMonitorResult[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ConnectionMonitorResult]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ConnectionMonitorResult]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ConnectionMonitorResult, index: number, array: ConnectionMonitorResult[]): boolean
        • Parameters

          • value: ConnectionMonitorResult
          • index: number
          • array: ConnectionMonitorResult[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ConnectionMonitorResult, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ConnectionMonitorResult

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ConnectionMonitorResult[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ConnectionMonitorResult

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ConnectionMonitorResult, index: number, array: ConnectionMonitorResult[]): boolean
        • Parameters

          • value: ConnectionMonitorResult
          • index: number
          • array: ConnectionMonitorResult[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ConnectionMonitorResult, index: number, array: ConnectionMonitorResult[]): any
        • Parameters

          • value: ConnectionMonitorResult
          • index: number
          • array: ConnectionMonitorResult[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ConnectionMonitorResult[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ConnectionMonitorResult | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ConnectionMonitorResult

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ConnectionMonitorResult, index: number, obj: ConnectionMonitorResult[]): boolean
        • Parameters

          • this: void
          • value: ConnectionMonitorResult
          • index: number
          • obj: ConnectionMonitorResult[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ConnectionMonitorResult, index: number, obj: ConnectionMonitorResult[]): boolean
        • Parameters

          • value: ConnectionMonitorResult
          • index: number
          • obj: ConnectionMonitorResult[]

          Returns boolean

    • Optional thisArg: any

    Returns ConnectionMonitorResult | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ConnectionMonitorResult, index: number, obj: ConnectionMonitorResult[]): boolean
        • Parameters

          • value: ConnectionMonitorResult
          • index: number
          • obj: ConnectionMonitorResult[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ConnectionMonitorResult, index: number, array: ConnectionMonitorResult[]): void
        • Parameters

          • value: ConnectionMonitorResult
          • index: number
          • array: ConnectionMonitorResult[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ConnectionMonitorResult, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ConnectionMonitorResult

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ConnectionMonitorResult, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ConnectionMonitorResult

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ConnectionMonitorResult, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ConnectionMonitorResult

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ConnectionMonitorResult, index: number, array: ConnectionMonitorResult[]): U
        • Parameters

          • value: ConnectionMonitorResult
          • index: number
          • array: ConnectionMonitorResult[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ConnectionMonitorResult | undefined
  • Removes the last element from an array and returns it.

    Returns ConnectionMonitorResult | undefined

push

  • push(...items: ConnectionMonitorResult[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ConnectionMonitorResult[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ConnectionMonitorResult
  • reduce(callbackfn: function, initialValue: ConnectionMonitorResult): ConnectionMonitorResult
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ConnectionMonitorResult, currentValue: ConnectionMonitorResult, currentIndex: number, array: ConnectionMonitorResult[]): ConnectionMonitorResult
        • Parameters

          • previousValue: ConnectionMonitorResult
          • currentValue: ConnectionMonitorResult
          • currentIndex: number
          • array: ConnectionMonitorResult[]

          Returns ConnectionMonitorResult

    Returns ConnectionMonitorResult

  • Parameters

    • callbackfn: function
        • (previousValue: ConnectionMonitorResult, currentValue: ConnectionMonitorResult, currentIndex: number, array: ConnectionMonitorResult[]): ConnectionMonitorResult
        • Parameters

          • previousValue: ConnectionMonitorResult
          • currentValue: ConnectionMonitorResult
          • currentIndex: number
          • array: ConnectionMonitorResult[]

          Returns ConnectionMonitorResult

    • initialValue: ConnectionMonitorResult

    Returns ConnectionMonitorResult

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ConnectionMonitorResult, currentIndex: number, array: ConnectionMonitorResult[]): U
        • Parameters

          • previousValue: U
          • currentValue: ConnectionMonitorResult
          • currentIndex: number
          • array: ConnectionMonitorResult[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ConnectionMonitorResult
  • reduceRight(callbackfn: function, initialValue: ConnectionMonitorResult): ConnectionMonitorResult
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ConnectionMonitorResult, currentValue: ConnectionMonitorResult, currentIndex: number, array: ConnectionMonitorResult[]): ConnectionMonitorResult
        • Parameters

          • previousValue: ConnectionMonitorResult
          • currentValue: ConnectionMonitorResult
          • currentIndex: number
          • array: ConnectionMonitorResult[]

          Returns ConnectionMonitorResult

    Returns ConnectionMonitorResult

  • Parameters

    • callbackfn: function
        • (previousValue: ConnectionMonitorResult, currentValue: ConnectionMonitorResult, currentIndex: number, array: ConnectionMonitorResult[]): ConnectionMonitorResult
        • Parameters

          • previousValue: ConnectionMonitorResult
          • currentValue: ConnectionMonitorResult
          • currentIndex: number
          • array: ConnectionMonitorResult[]

          Returns ConnectionMonitorResult

    • initialValue: ConnectionMonitorResult

    Returns ConnectionMonitorResult

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ConnectionMonitorResult, currentIndex: number, array: ConnectionMonitorResult[]): U
        • Parameters

          • previousValue: U
          • currentValue: ConnectionMonitorResult
          • currentIndex: number
          • array: ConnectionMonitorResult[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ConnectionMonitorResult[]
  • Reverses the elements in an Array.

    Returns ConnectionMonitorResult[]

shift

  • shift(): ConnectionMonitorResult | undefined
  • Removes the first element from an array and returns it.

    Returns ConnectionMonitorResult | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ConnectionMonitorResult[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ConnectionMonitorResult[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ConnectionMonitorResult, index: number, array: ConnectionMonitorResult[]): boolean
        • Parameters

          • value: ConnectionMonitorResult
          • index: number
          • array: ConnectionMonitorResult[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ConnectionMonitorResult[]
  • splice(start: number, deleteCount: number, ...items: ConnectionMonitorResult[]): ConnectionMonitorResult[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ConnectionMonitorResult[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ConnectionMonitorResult[]

      Elements to insert into the array in place of the deleted elements.

    Returns ConnectionMonitorResult[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ConnectionMonitorResult[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ConnectionMonitorResult[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ConnectionMonitorResult>
  • Returns an iterable of values in the array

    Returns IterableIterator<ConnectionMonitorResult>

type

type: object

className

className: string = "ConnectionMonitorListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ConnectionMonitorResult"

name

name: "Composite" = "Composite"

Const ConnectionMonitorParameters

ConnectionMonitorParameters: object

Parameters that define the operation to create a connection monitor.

Optional autoStart

autoStart: undefined | false | true

Determines if the connection monitor will start automatically once created. Default value: true.

destination

destination: ConnectionMonitorDestination

Describes the destination of connection monitor.

Optional monitoringIntervalInSeconds

monitoringIntervalInSeconds: undefined | number

Monitoring interval in seconds. Default value: 60.

serializedName

serializedName: string = "ConnectionMonitorParameters"

source

source: ConnectionMonitorSource

Describes the source of connection monitor.

type

type: object

className

className: string = "ConnectionMonitorParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

autoStart

autoStart: object

defaultValue

defaultValue: boolean = true

serializedName

serializedName: string = "autoStart"

type

type: object

name

name: "Boolean" = "Boolean"

destination

destination: object

required

required: true = true

serializedName

serializedName: string = "destination"

type

type: object

className

className: string = "ConnectionMonitorDestination"

name

name: "Composite" = "Composite"

monitoringIntervalInSeconds

monitoringIntervalInSeconds: object

defaultValue

defaultValue: number = 60

serializedName

serializedName: string = "monitoringIntervalInSeconds"

type

type: object

name

name: "Number" = "Number"

source

source: object

required

required: true = true

serializedName

serializedName: string = "source"

type

type: object

className

className: string = "ConnectionMonitorSource"

name

name: "Composite" = "Composite"

Const ConnectionMonitorQueryResult

ConnectionMonitorQueryResult: object

List of connection states snapshots.

serializedName

serializedName: string = "ConnectionMonitorQueryResult"

Optional sourceStatus

Status of connection monitor source. Possible values include: 'Unknown', 'Active', 'Inactive'

Optional states

states: ConnectionStateSnapshot[]

Information about connection states.

type

type: object

className

className: string = "ConnectionMonitorQueryResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

sourceStatus

sourceStatus: object

serializedName

serializedName: string = "sourceStatus"

type

type: object

name

name: "String" = "String"

states

states: object

serializedName

serializedName: string = "states"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ConnectionStateSnapshot"

name

name: "Composite" = "Composite"

Const ConnectionMonitorResult

ConnectionMonitorResult: object

Information about the connection monitor.

Optional autoStart

autoStart: undefined | false | true

Determines if the connection monitor will start automatically once created. Default value: true.

destination

destination: ConnectionMonitorDestination

Describes the destination of connection monitor.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated. Default value: 'A unique read-only string that changes whenever the resource is updated.'.

Optional id

id: undefined | string

ID of the connection monitor. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

Connection monitor location.

Optional monitoringIntervalInSeconds

monitoringIntervalInSeconds: undefined | number

Monitoring interval in seconds. Default value: 60.

Optional monitoringStatus

monitoringStatus: undefined | string

The monitoring status of the connection monitor.

Optional name

name: undefined | string

Name of the connection monitor. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: ProvisioningState

The provisioning state of the connection monitor. Possible values include: 'Succeeded', 'Updating', 'Deleting', 'Failed'

serializedName

serializedName: string = "ConnectionMonitorResult"

source

source: ConnectionMonitorSource

Describes the source of connection monitor.

Optional startTime

startTime: Date

The date and time when the connection monitor was started.

Optional tags

tags: undefined | object

Connection monitor tags.

type

type: object

Connection monitor type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "ConnectionMonitorResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

autoStart

autoStart: object

defaultValue

defaultValue: boolean = true

serializedName

serializedName: string = "properties.autoStart"

type

type: object

name

name: "Boolean" = "Boolean"

destination

destination: object

required

required: true = true

serializedName

serializedName: string = "properties.destination"

type

type: object

className

className: string = "ConnectionMonitorDestination"

name

name: "Composite" = "Composite"

etag

etag: object

defaultValue

defaultValue: string = "A unique read-only string that changes whenever the resource is updated."

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

monitoringIntervalInSeconds

monitoringIntervalInSeconds: object

defaultValue

defaultValue: number = 60

serializedName

serializedName: string = "properties.monitoringIntervalInSeconds"

type

type: object

name

name: "Number" = "Number"

monitoringStatus

monitoringStatus: object

serializedName

serializedName: string = "properties.monitoringStatus"

type

type: object

name

name: "String" = "String"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

source

source: object

required

required: true = true

serializedName

serializedName: string = "properties.source"

type

type: object

className

className: string = "ConnectionMonitorSource"

name

name: "Composite" = "Composite"

startTime

startTime: object

serializedName

serializedName: string = "properties.startTime"

type

type: object

name

name: "DateTime" = "DateTime"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const ConnectionMonitorSource

ConnectionMonitorSource: object

Describes the source of connection monitor.

Optional port

port: undefined | number

The source port used by connection monitor.

resourceId

resourceId: string

The ID of the resource used as the source by connection monitor.

serializedName

serializedName: string = "ConnectionMonitorSource"

type

type: object

className

className: string = "ConnectionMonitorSource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

port

port: object

serializedName

serializedName: string = "port"

type

type: object

name

name: "Number" = "Number"

resourceId

resourceId: object

required

required: true = true

serializedName

serializedName: string = "resourceId"

type

type: object

name

name: "String" = "String"

Const ConnectionResetSharedKey

ConnectionResetSharedKey: object

The virtual network connection reset shared key.

keyLength

keyLength: number

The virtual network connection reset shared key length, should between 1 and 128.

serializedName

serializedName: string = "ConnectionResetSharedKey"

type

type: object

className

className: string = "ConnectionResetSharedKey"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

keyLength

keyLength: object

required

required: true = true

serializedName

serializedName: string = "keyLength"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 128

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: "Number" = "Number"

Const ConnectionSharedKey

ConnectionSharedKey: object

Response for GetConnectionSharedKey API service call.

Optional id

id: undefined | string

Resource ID.

serializedName

serializedName: string = "ConnectionSharedKey"

value

value: string

The virtual network connection shared key value.

type

type: object

className

className: string = "ConnectionSharedKey"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

required

required: true = true

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const ConnectionStateSnapshot

ConnectionStateSnapshot: object

Connection state snapshot.

Optional avgLatencyInMs

avgLatencyInMs: undefined | number

Average latency in ms.

Optional connectionState

connectionState: ConnectionState

The connection state. Possible values include: 'Reachable', 'Unreachable', 'Unknown'

Optional endTime

endTime: Date

The end time of the connection snapshot.

Optional evaluationState

evaluationState: EvaluationState

Connectivity analysis evaluation state. Possible values include: 'NotStarted', 'InProgress', 'Completed'

Optional hops

hops: ConnectivityHop[]

List of hops between the source and the destination. NOTE: This property will not be serialized. It can only be populated by the server.

Optional maxLatencyInMs

maxLatencyInMs: undefined | number

Maximum latency in ms.

Optional minLatencyInMs

minLatencyInMs: undefined | number

Minimum latency in ms.

Optional probesFailed

probesFailed: undefined | number

The number of failed probes.

Optional probesSent

probesSent: undefined | number

The number of sent probes.

serializedName

serializedName: string = "ConnectionStateSnapshot"

Optional startTime

startTime: Date

The start time of the connection snapshot.

type

type: object

className

className: string = "ConnectionStateSnapshot"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

avgLatencyInMs

avgLatencyInMs: object

serializedName

serializedName: string = "avgLatencyInMs"

type

type: object

name

name: "Number" = "Number"

connectionState

connectionState: object

serializedName

serializedName: string = "connectionState"

type

type: object

name

name: "String" = "String"

endTime

endTime: object

serializedName

serializedName: string = "endTime"

type

type: object

name

name: "DateTime" = "DateTime"

evaluationState

evaluationState: object

serializedName

serializedName: string = "evaluationState"

type

type: object

name

name: "String" = "String"

hops

hops: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "hops"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ConnectivityHop"

name

name: "Composite" = "Composite"

maxLatencyInMs

maxLatencyInMs: object

serializedName

serializedName: string = "maxLatencyInMs"

type

type: object

name

name: "Number" = "Number"

minLatencyInMs

minLatencyInMs: object

serializedName

serializedName: string = "minLatencyInMs"

type

type: object

name

name: "Number" = "Number"

probesFailed

probesFailed: object

serializedName

serializedName: string = "probesFailed"

type

type: object

name

name: "Number" = "Number"

probesSent

probesSent: object

serializedName

serializedName: string = "probesSent"

type

type: object

name

name: "Number" = "Number"

startTime

startTime: object

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

Const ConnectivityDestination

ConnectivityDestination: object

Parameters that define destination of connection.

Optional address

address: undefined | string

The IP address or URI the resource to which a connection attempt will be made.

Optional port

port: undefined | number

Port on which check connectivity will be performed.

Optional resourceId

resourceId: undefined | string

The ID of the resource to which a connection attempt will be made.

serializedName

serializedName: string = "ConnectivityDestination"

type

type: object

className

className: string = "ConnectivityDestination"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

address

address: object

serializedName

serializedName: string = "address"

type

type: object

name

name: "String" = "String"

port

port: object

serializedName

serializedName: string = "port"

type

type: object

name

name: "Number" = "Number"

resourceId

resourceId: object

serializedName

serializedName: string = "resourceId"

type

type: object

name

name: "String" = "String"

Const ConnectivityHop

ConnectivityHop: object

Information about a hop between the source and the destination.

Optional address

address: undefined | string

The IP address of the hop. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

The ID of the hop. NOTE: This property will not be serialized. It can only be populated by the server.

Optional issues

issues: ConnectivityIssue[]

List of issues. NOTE: This property will not be serialized. It can only be populated by the server.

Optional nextHopIds

nextHopIds: string[]

List of next hop identifiers. NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceId

resourceId: undefined | string

The ID of the resource corresponding to this hop. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ConnectivityHop"

type

type: object

The type of the hop. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "ConnectivityHop"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

address

address: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "address"

type

type: object

name

name: "String" = "String"

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

issues

issues: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "issues"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ConnectivityIssue"

name

name: "Composite" = "Composite"

nextHopIds

nextHopIds: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextHopIds"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

resourceId

resourceId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "resourceId"

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const ConnectivityInformation

ConnectivityInformation: object

Information on the connectivity status.

Optional avgLatencyInMs

avgLatencyInMs: undefined | number

Average latency in milliseconds. NOTE: This property will not be serialized. It can only be populated by the server.

Optional connectionStatus

connectionStatus: ConnectionStatus

The connection status. Possible values include: 'Unknown', 'Connected', 'Disconnected', 'Degraded' NOTE: This property will not be serialized. It can only be populated by the server.

Optional hops

hops: ConnectivityHop[]

List of hops between the source and the destination. NOTE: This property will not be serialized. It can only be populated by the server.

Optional maxLatencyInMs

maxLatencyInMs: undefined | number

Maximum latency in milliseconds. NOTE: This property will not be serialized. It can only be populated by the server.

Optional minLatencyInMs

minLatencyInMs: undefined | number

Minimum latency in milliseconds. NOTE: This property will not be serialized. It can only be populated by the server.

Optional probesFailed

probesFailed: undefined | number

Number of failed probes. NOTE: This property will not be serialized. It can only be populated by the server.

Optional probesSent

probesSent: undefined | number

Total number of probes sent. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ConnectivityInformation"

type

type: object

className

className: string = "ConnectivityInformation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

avgLatencyInMs

avgLatencyInMs: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "avgLatencyInMs"

type

type: object

name

name: "Number" = "Number"

connectionStatus

connectionStatus: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "connectionStatus"

type

type: object

name

name: "String" = "String"

hops

hops: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "hops"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ConnectivityHop"

name

name: "Composite" = "Composite"

maxLatencyInMs

maxLatencyInMs: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "maxLatencyInMs"

type

type: object

name

name: "Number" = "Number"

minLatencyInMs

minLatencyInMs: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "minLatencyInMs"

type

type: object

name

name: "Number" = "Number"

probesFailed

probesFailed: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "probesFailed"

type

type: object

name

name: "Number" = "Number"

probesSent

probesSent: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "probesSent"

type

type: object

name

name: "Number" = "Number"

Const ConnectivityIssue

ConnectivityIssue: object

Information about an issue encountered in the process of checking for connectivity.

Optional context

context: object[]

Provides additional context on the issue. NOTE: This property will not be serialized. It can only be populated by the server.

Optional origin

origin: Origin

The origin of the issue. Possible values include: 'Local', 'Inbound', 'Outbound' NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ConnectivityIssue"

Optional severity

severity: Severity

The severity of the issue. Possible values include: 'Error', 'Warning' NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

The type of issue. Possible values include: 'Unknown', 'AgentStopped', 'GuestFirewall', 'DnsResolution', 'SocketBind', 'NetworkSecurityRule', 'UserDefinedRoute', 'PortThrottled', 'Platform' NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "ConnectivityIssue"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

context

context: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "context"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

origin

origin: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "origin"

type

type: object

name

name: "String" = "String"

severity

severity: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "severity"

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const ConnectivityParameters

ConnectivityParameters: object

Parameters that determine how the connectivity check will be performed.

destination

destination: ConnectivityDestination

Describes the destination of connection.

Optional protocol

protocol: Protocol

Network protocol. Possible values include: 'Tcp', 'Http', 'Https', 'Icmp'

Optional protocolConfiguration

protocolConfiguration: ProtocolConfiguration

Configuration of the protocol.

serializedName

serializedName: string = "ConnectivityParameters"

source

source: ConnectivitySource

Describes the source of the connection.

type

type: object

className

className: string = "ConnectivityParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

destination

destination: object

required

required: true = true

serializedName

serializedName: string = "destination"

type

type: object

className

className: string = "ConnectivityDestination"

name

name: "Composite" = "Composite"

protocol

protocol: object

serializedName

serializedName: string = "protocol"

type

type: object

name

name: "String" = "String"

protocolConfiguration

protocolConfiguration: object

serializedName

serializedName: string = "protocolConfiguration"

type

type: object

className

className: string = "ProtocolConfiguration"

name

name: "Composite" = "Composite"

source

source: object

required

required: true = true

serializedName

serializedName: string = "source"

type

type: object

className

className: string = "ConnectivitySource"

name

name: "Composite" = "Composite"

Const ConnectivitySource

ConnectivitySource: object

Parameters that define the source of the connection.

Optional port

port: undefined | number

The source port from which a connectivity check will be performed.

resourceId

resourceId: string

The ID of the resource from which a connectivity check will be initiated.

serializedName

serializedName: string = "ConnectivitySource"

type

type: object

className

className: string = "ConnectivitySource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

port

port: object

serializedName

serializedName: string = "port"

type

type: object

name

name: "Number" = "Number"

resourceId

resourceId: object

required

required: true = true

serializedName

serializedName: string = "resourceId"

type

type: object

name

name: "String" = "String"

Const Container

Container: object

Reference to container resource in remote resource provider.

Optional id

id: undefined | string

Resource ID.

serializedName

serializedName: string = "Container"

type

type: object

className

className: string = "Container"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

Const ContainerNetworkInterface

ContainerNetworkInterface: object

Container network interface child resource.

Optional container

container: Container

Reference to the container to which this container network interface is attached.

Optional containerNetworkInterfaceConfiguration

containerNetworkInterfaceConfiguration: ContainerNetworkInterfaceConfiguration

Container network interface configuration from which this container network interface is created.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional ipConfigurations

ipConfigurations: ContainerNetworkInterfaceIpConfiguration[]

Reference to the ip configuration on this container nic.

Optional name

name: undefined | string

The name of the resource. This name can be used to access the resource.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ContainerNetworkInterface"

type

type: object

Sub Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "ContainerNetworkInterface"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

container

container: object

serializedName

serializedName: string = "properties.container"

type

type: object

className

className: string = "Container"

name

name: "Composite" = "Composite"

containerNetworkInterfaceConfiguration

containerNetworkInterfaceConfiguration: object

serializedName

serializedName: string = "properties.containerNetworkInterfaceConfiguration"

type

type: object

className

className: string = "ContainerNetworkInterfaceConfiguration"

name

name: "Composite" = "Composite"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

ipConfigurations

ipConfigurations: object

serializedName

serializedName: string = "properties.ipConfigurations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ContainerNetworkInterfaceIpConfiguration"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const ContainerNetworkInterfaceConfiguration

ContainerNetworkInterfaceConfiguration: object

Container network interface configuration child resource.

Optional containerNetworkInterfaces

containerNetworkInterfaces: SubResource[]

A list of container network interfaces created from this container network interface configuration.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional ipConfigurations

ipConfigurations: IPConfigurationProfile[]

A list of ip configurations of the container network interface configuration.

Optional name

name: undefined | string

The name of the resource. This name can be used to access the resource.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ContainerNetworkInterfaceConfiguration"

type

type: object

Sub Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "ContainerNetworkInterfaceConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

containerNetworkInterfaces

containerNetworkInterfaces: object

serializedName

serializedName: string = "properties.containerNetworkInterfaces"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

ipConfigurations

ipConfigurations: object

serializedName

serializedName: string = "properties.ipConfigurations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "IPConfigurationProfile"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const ContainerNetworkInterfaceIpConfiguration

ContainerNetworkInterfaceIpConfiguration: object

The ip configuration for a container network interface.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional name

name: undefined | string

The name of the resource. This name can be used to access the resource.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ContainerNetworkInterfaceIpConfiguration"

type

type: object

Sub Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "ContainerNetworkInterfaceIpConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const DdosCustomPolicy

DdosCustomPolicy: object

A DDoS custom policy in a resource group.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional protocolCustomSettings

protocolCustomSettings: ProtocolCustomSettingsFormat[]

The protocol-specific DDoS policy customization parameters.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the DDoS custom policy resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. NOTE: This property will not be serialized. It can only be populated by the server.

Optional publicIPAddresses

publicIPAddresses: SubResource[]

The list of public IPs associated with the DDoS custom policy resource. This list is read-only. NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceGuid

resourceGuid: undefined | string

The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "DdosCustomPolicy"

Optional tags

tags: undefined | object

Resource tags.

type

type: object

className

className: string = "DdosCustomPolicy"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

etag

etag: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

protocolCustomSettings

protocolCustomSettings: object

serializedName

serializedName: string = "properties.protocolCustomSettings"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ProtocolCustomSettingsFormat"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

publicIPAddresses

publicIPAddresses: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.publicIPAddresses"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

resourceGuid

resourceGuid: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.resourceGuid"

type

type: object

name

name: "String" = "String"

Const DdosProtectionPlan

DdosProtectionPlan: object

A DDoS protection plan in a resource group.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the DDoS protection plan resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceGuid

resourceGuid: undefined | string

The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "DdosProtectionPlan"

Optional tags

tags: undefined | object

Resource tags.

Optional virtualNetworks

virtualNetworks: SubResource[]

The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "DdosProtectionPlan"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

etag

etag: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

resourceGuid

resourceGuid: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.resourceGuid"

type

type: object

name

name: "String" = "String"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

virtualNetworks

virtualNetworks: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.virtualNetworks"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

Const DdosProtectionPlanListResult

DdosProtectionPlanListResult: object
interface

A list of DDoS protection plans.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "DdosProtectionPlanListResult"

__@iterator

  • __@iterator(): IterableIterator<DdosProtectionPlan>
  • Iterator

    Returns IterableIterator<DdosProtectionPlan>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<DdosProtectionPlan>[]): DdosProtectionPlan[]
  • concat(...items: (T | ConcatArray<T>)[]): DdosProtectionPlan[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<DdosProtectionPlan>[]

      Additional items to add to the end of array1.

    Returns DdosProtectionPlan[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns DdosProtectionPlan[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, DdosProtectionPlan]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, DdosProtectionPlan]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: DdosProtectionPlan, index: number, array: DdosProtectionPlan[]): boolean
        • Parameters

          • value: DdosProtectionPlan
          • index: number
          • array: DdosProtectionPlan[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: DdosProtectionPlan, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: DdosProtectionPlan

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): DdosProtectionPlan[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: DdosProtectionPlan

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: DdosProtectionPlan, index: number, array: DdosProtectionPlan[]): boolean
        • Parameters

          • value: DdosProtectionPlan
          • index: number
          • array: DdosProtectionPlan[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: DdosProtectionPlan, index: number, array: DdosProtectionPlan[]): any
        • Parameters

          • value: DdosProtectionPlan
          • index: number
          • array: DdosProtectionPlan[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns DdosProtectionPlan[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): DdosProtectionPlan | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: DdosProtectionPlan

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: DdosProtectionPlan, index: number, obj: DdosProtectionPlan[]): boolean
        • Parameters

          • this: void
          • value: DdosProtectionPlan
          • index: number
          • obj: DdosProtectionPlan[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: DdosProtectionPlan, index: number, obj: DdosProtectionPlan[]): boolean
        • Parameters

          • value: DdosProtectionPlan
          • index: number
          • obj: DdosProtectionPlan[]

          Returns boolean

    • Optional thisArg: any

    Returns DdosProtectionPlan | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: DdosProtectionPlan, index: number, obj: DdosProtectionPlan[]): boolean
        • Parameters

          • value: DdosProtectionPlan
          • index: number
          • obj: DdosProtectionPlan[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: DdosProtectionPlan, index: number, array: DdosProtectionPlan[]): void
        • Parameters

          • value: DdosProtectionPlan
          • index: number
          • array: DdosProtectionPlan[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: DdosProtectionPlan, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: DdosProtectionPlan

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: DdosProtectionPlan, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: DdosProtectionPlan

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: DdosProtectionPlan, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: DdosProtectionPlan

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: DdosProtectionPlan, index: number, array: DdosProtectionPlan[]): U
        • Parameters

          • value: DdosProtectionPlan
          • index: number
          • array: DdosProtectionPlan[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): DdosProtectionPlan | undefined
  • Removes the last element from an array and returns it.

    Returns DdosProtectionPlan | undefined

push

  • push(...items: DdosProtectionPlan[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: DdosProtectionPlan[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): DdosProtectionPlan
  • reduce(callbackfn: function, initialValue: DdosProtectionPlan): DdosProtectionPlan
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: DdosProtectionPlan, currentValue: DdosProtectionPlan, currentIndex: number, array: DdosProtectionPlan[]): DdosProtectionPlan
        • Parameters

          • previousValue: DdosProtectionPlan
          • currentValue: DdosProtectionPlan
          • currentIndex: number
          • array: DdosProtectionPlan[]

          Returns DdosProtectionPlan

    Returns DdosProtectionPlan

  • Parameters

    • callbackfn: function
        • (previousValue: DdosProtectionPlan, currentValue: DdosProtectionPlan, currentIndex: number, array: DdosProtectionPlan[]): DdosProtectionPlan
        • Parameters

          • previousValue: DdosProtectionPlan
          • currentValue: DdosProtectionPlan
          • currentIndex: number
          • array: DdosProtectionPlan[]

          Returns DdosProtectionPlan

    • initialValue: DdosProtectionPlan

    Returns DdosProtectionPlan

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: DdosProtectionPlan, currentIndex: number, array: DdosProtectionPlan[]): U
        • Parameters

          • previousValue: U
          • currentValue: DdosProtectionPlan
          • currentIndex: number
          • array: DdosProtectionPlan[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): DdosProtectionPlan
  • reduceRight(callbackfn: function, initialValue: DdosProtectionPlan): DdosProtectionPlan
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: DdosProtectionPlan, currentValue: DdosProtectionPlan, currentIndex: number, array: DdosProtectionPlan[]): DdosProtectionPlan
        • Parameters

          • previousValue: DdosProtectionPlan
          • currentValue: DdosProtectionPlan
          • currentIndex: number
          • array: DdosProtectionPlan[]

          Returns DdosProtectionPlan

    Returns DdosProtectionPlan

  • Parameters

    • callbackfn: function
        • (previousValue: DdosProtectionPlan, currentValue: DdosProtectionPlan, currentIndex: number, array: DdosProtectionPlan[]): DdosProtectionPlan
        • Parameters

          • previousValue: DdosProtectionPlan
          • currentValue: DdosProtectionPlan
          • currentIndex: number
          • array: DdosProtectionPlan[]

          Returns DdosProtectionPlan

    • initialValue: DdosProtectionPlan

    Returns DdosProtectionPlan

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: DdosProtectionPlan, currentIndex: number, array: DdosProtectionPlan[]): U
        • Parameters

          • previousValue: U
          • currentValue: DdosProtectionPlan
          • currentIndex: number
          • array: DdosProtectionPlan[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): DdosProtectionPlan[]
  • Reverses the elements in an Array.

    Returns DdosProtectionPlan[]

shift

  • shift(): DdosProtectionPlan | undefined
  • Removes the first element from an array and returns it.

    Returns DdosProtectionPlan | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): DdosProtectionPlan[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns DdosProtectionPlan[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: DdosProtectionPlan, index: number, array: DdosProtectionPlan[]): boolean
        • Parameters

          • value: DdosProtectionPlan
          • index: number
          • array: DdosProtectionPlan[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): DdosProtectionPlan[]
  • splice(start: number, deleteCount: number, ...items: DdosProtectionPlan[]): DdosProtectionPlan[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns DdosProtectionPlan[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: DdosProtectionPlan[]

      Elements to insert into the array in place of the deleted elements.

    Returns DdosProtectionPlan[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: DdosProtectionPlan[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: DdosProtectionPlan[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<DdosProtectionPlan>
  • Returns an iterable of values in the array

    Returns IterableIterator<DdosProtectionPlan>

type

type: object

className

className: string = "DdosProtectionPlanListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DdosProtectionPlan"

name

name: "Composite" = "Composite"

Const DdosSettings

DdosSettings: object

Contains the DDoS protection settings of the public IP.

Optional ddosCustomPolicy

ddosCustomPolicy: SubResource

The DDoS custom policy associated with the public IP.

Optional protectionCoverage

protectionCoverage: DdosSettingsProtectionCoverage

The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. Possible values include: 'Basic', 'Standard'

serializedName

serializedName: string = "DdosSettings"

type

type: object

className

className: string = "DdosSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

ddosCustomPolicy

ddosCustomPolicy: object

serializedName

serializedName: string = "ddosCustomPolicy"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

protectionCoverage

protectionCoverage: object

serializedName

serializedName: string = "protectionCoverage"

type

type: object

name

name: "String" = "String"

Const Delegation

Delegation: object

Details the service to which the subnet is delegated.

Optional actions

actions: string[]

Describes the actions permitted to the service upon delegation.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

The name of the resource that is unique within a subnet. This name can be used to access the resource.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Delegation"

Optional serviceName

serviceName: undefined | string

The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers).

type

type: object

className

className: string = "Delegation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

actions

actions: object

serializedName

serializedName: string = "properties.actions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

serviceName

serviceName: object

serializedName

serializedName: string = "properties.serviceName"

type

type: object

name

name: "String" = "String"

Const DeviceProperties

DeviceProperties: object

List of properties of the device.

Optional deviceModel

deviceModel: undefined | string

Model of the device.

Optional deviceVendor

deviceVendor: undefined | string

Name of the device Vendor.

Optional linkSpeedInMbps

linkSpeedInMbps: undefined | number

Link speed.

serializedName

serializedName: string = "DeviceProperties"

type

type: object

className

className: string = "DeviceProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

deviceModel

deviceModel: object

serializedName

serializedName: string = "deviceModel"

type

type: object

name

name: "String" = "String"

deviceVendor

deviceVendor: object

serializedName

serializedName: string = "deviceVendor"

type

type: object

name

name: "String" = "String"

linkSpeedInMbps

linkSpeedInMbps: object

serializedName

serializedName: string = "linkSpeedInMbps"

type

type: object

name

name: "Number" = "Number"

Const DhcpOptions

DhcpOptions: object

DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options.

Optional dnsServers

dnsServers: string[]

The list of DNS servers IP addresses.

serializedName

serializedName: string = "DhcpOptions"

type

type: object

className

className: string = "DhcpOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dnsServers

dnsServers: object

serializedName

serializedName: string = "dnsServers"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const Dimension

Dimension: object

Dimension of the metric.

Optional displayName

displayName: undefined | string

The display name of the dimension.

Optional internalName

internalName: undefined | string

The internal name of the dimension.

Optional name

name: undefined | string

The name of the dimension.

serializedName

serializedName: string = "Dimension"

type

type: object

className

className: string = "Dimension"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

displayName

displayName: object

serializedName

serializedName: string = "displayName"

type

type: object

name

name: "String" = "String"

internalName

internalName: object

serializedName

serializedName: string = "internalName"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const DnsNameAvailabilityResult

DnsNameAvailabilityResult: object

Response for the CheckDnsNameAvailability API service call.

Optional available

available: undefined | false | true

Domain availability (True/False).

serializedName

serializedName: string = "DnsNameAvailabilityResult"

type

type: object

className

className: string = "DnsNameAvailabilityResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

available

available: object

serializedName

serializedName: string = "available"

type

type: object

name

name: "Boolean" = "Boolean"

Const EffectiveNetworkSecurityGroup

EffectiveNetworkSecurityGroup: object

Effective network security group.

Optional association

Associated resources.

Optional effectiveSecurityRules

effectiveSecurityRules: EffectiveNetworkSecurityRule[]

A collection of effective security rules.

Optional networkSecurityGroup

networkSecurityGroup: SubResource

The ID of network security group that is applied.

serializedName

serializedName: string = "EffectiveNetworkSecurityGroup"

Optional tagMap

tagMap: undefined | object

Mapping of tags to list of IP Addresses included within the tag.

type

type: object

className

className: string = "EffectiveNetworkSecurityGroup"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

association

association: object

serializedName

serializedName: string = "association"

type

type: object

className

className: string = "EffectiveNetworkSecurityGroupAssociation"

name

name: "Composite" = "Composite"

effectiveSecurityRules

effectiveSecurityRules: object

serializedName

serializedName: string = "effectiveSecurityRules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "EffectiveNetworkSecurityRule"

name

name: "Composite" = "Composite"

networkSecurityGroup

networkSecurityGroup: object

serializedName

serializedName: string = "networkSecurityGroup"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

tagMap

tagMap: object

serializedName

serializedName: string = "tagMap"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const EffectiveNetworkSecurityGroupAssociation

EffectiveNetworkSecurityGroupAssociation: object

The effective network security group association.

Optional networkInterface

networkInterface: SubResource

The ID of the network interface if assigned.

serializedName

serializedName: string = "EffectiveNetworkSecurityGroupAssociation"

Optional subnet

subnet: SubResource

The ID of the subnet if assigned.

type

type: object

className

className: string = "EffectiveNetworkSecurityGroupAssociation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

networkInterface

networkInterface: object

serializedName

serializedName: string = "networkInterface"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

subnet

subnet: object

serializedName

serializedName: string = "subnet"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

Const EffectiveNetworkSecurityGroupListResult

EffectiveNetworkSecurityGroupListResult: object

Response for list effective network security groups API service call.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "EffectiveNetworkSecurityGroupListResult"

Optional value

value: EffectiveNetworkSecurityGroup[]

A list of effective network security groups.

type

type: object

className

className: string = "EffectiveNetworkSecurityGroupListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "EffectiveNetworkSecurityGroup"

name

name: "Composite" = "Composite"

Const EffectiveNetworkSecurityRule

EffectiveNetworkSecurityRule: object

Effective network security rules.

Optional access

Whether network traffic is allowed or denied. Possible values include: 'Allow', 'Deny'

Optional destinationAddressPrefix

destinationAddressPrefix: undefined | string

The destination address prefix.

Optional destinationAddressPrefixes

destinationAddressPrefixes: string[]

The destination address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AzureLoadBalancer, Internet), System Tags, and the asterisk (*).

Optional destinationPortRange

destinationPortRange: undefined | string

The destination port or range.

Optional destinationPortRanges

destinationPortRanges: string[]

The destination port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as separator (e.g. 100-400), or an asterisk (*).

Optional direction

The direction of the rule. Possible values include: 'Inbound', 'Outbound'

Optional expandedDestinationAddressPrefix

expandedDestinationAddressPrefix: string[]

Expanded destination address prefix.

Optional expandedSourceAddressPrefix

expandedSourceAddressPrefix: string[]

The expanded source address prefix.

Optional name

name: undefined | string

The name of the security rule specified by the user (if created by the user).

Optional priority

priority: undefined | number

The priority of the rule.

Optional protocol

The network protocol this rule applies to. Possible values include: 'Tcp', 'Udp', 'All'

serializedName

serializedName: string = "EffectiveNetworkSecurityRule"

Optional sourceAddressPrefix

sourceAddressPrefix: undefined | string

The source address prefix.

Optional sourceAddressPrefixes

sourceAddressPrefixes: string[]

The source address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AzureLoadBalancer, Internet), System Tags, and the asterisk (*).

Optional sourcePortRange

sourcePortRange: undefined | string

The source port or range.

Optional sourcePortRanges

sourcePortRanges: string[]

The source port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as separator (e.g. 100-400), or an asterisk (*).

type

type: object

className

className: string = "EffectiveNetworkSecurityRule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

access

access: object

serializedName

serializedName: string = "access"

type

type: object

name

name: "String" = "String"

destinationAddressPrefix

destinationAddressPrefix: object

serializedName

serializedName: string = "destinationAddressPrefix"

type

type: object

name

name: "String" = "String"

destinationAddressPrefixes

destinationAddressPrefixes: object

serializedName

serializedName: string = "destinationAddressPrefixes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

destinationPortRange

destinationPortRange: object

serializedName

serializedName: string = "destinationPortRange"

type

type: object

name

name: "String" = "String"

destinationPortRanges

destinationPortRanges: object

serializedName

serializedName: string = "destinationPortRanges"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

direction

direction: object

serializedName

serializedName: string = "direction"

type

type: object

name

name: "String" = "String"

expandedDestinationAddressPrefix

expandedDestinationAddressPrefix: object

serializedName

serializedName: string = "expandedDestinationAddressPrefix"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

expandedSourceAddressPrefix

expandedSourceAddressPrefix: object

serializedName

serializedName: string = "expandedSourceAddressPrefix"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

priority

priority: object

serializedName

serializedName: string = "priority"

type

type: object

name

name: "Number" = "Number"

protocol

protocol: object

serializedName

serializedName: string = "protocol"

type

type: object

name

name: "String" = "String"

sourceAddressPrefix

sourceAddressPrefix: object

serializedName

serializedName: string = "sourceAddressPrefix"

type

type: object

name

name: "String" = "String"

sourceAddressPrefixes

sourceAddressPrefixes: object

serializedName

serializedName: string = "sourceAddressPrefixes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

sourcePortRange

sourcePortRange: object

serializedName

serializedName: string = "sourcePortRange"

type

type: object

name

name: "String" = "String"

sourcePortRanges

sourcePortRanges: object

serializedName

serializedName: string = "sourcePortRanges"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const EffectiveRoute

EffectiveRoute: object

Effective Route.

Optional addressPrefix

addressPrefix: string[]

The address prefixes of the effective routes in CIDR notation.

Optional disableBgpRoutePropagation

disableBgpRoutePropagation: undefined | false | true

If true, on-premises routes are not propagated to the network interfaces in the subnet.

Optional name

name: undefined | string

The name of the user defined route. This is optional.

Optional nextHopIpAddress

nextHopIpAddress: string[]

The IP address of the next hop of the effective route.

Optional nextHopType

nextHopType: RouteNextHopType

The type of Azure hop the packet should be sent to. Possible values include: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', 'None'

serializedName

serializedName: string = "EffectiveRoute"

Optional source

Who created the route. Possible values include: 'Unknown', 'User', 'VirtualNetworkGateway', 'Default'

Optional state

The value of effective route. Possible values include: 'Active', 'Invalid'

type

type: object

className

className: string = "EffectiveRoute"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

addressPrefix

addressPrefix: object

serializedName

serializedName: string = "addressPrefix"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

disableBgpRoutePropagation

disableBgpRoutePropagation: object

serializedName

serializedName: string = "disableBgpRoutePropagation"

type

type: object

name

name: "Boolean" = "Boolean"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

nextHopIpAddress

nextHopIpAddress: object

serializedName

serializedName: string = "nextHopIpAddress"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

nextHopType

nextHopType: object

serializedName

serializedName: string = "nextHopType"

type

type: object

name

name: "String" = "String"

source

source: object

serializedName

serializedName: string = "source"

type

type: object

name

name: "String" = "String"

state

state: object

serializedName

serializedName: string = "state"

type

type: object

name

name: "String" = "String"

Const EffectiveRouteListResult

EffectiveRouteListResult: object

Response for list effective route API service call.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "EffectiveRouteListResult"

Optional value

value: EffectiveRoute[]

A list of effective routes.

type

type: object

className

className: string = "EffectiveRouteListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "EffectiveRoute"

name

name: "Composite" = "Composite"

Const EndpointServiceResult

EndpointServiceResult: object

Endpoint service.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

Name of the endpoint service. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "EndpointServiceResult"

type

type: object

Type of the endpoint service. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "EndpointServiceResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const EndpointServicesListResult

EndpointServicesListResult: object
interface

Response for the ListAvailableEndpointServices API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "EndpointServicesListResult"

__@iterator

  • __@iterator(): IterableIterator<EndpointServiceResult>
  • Iterator

    Returns IterableIterator<EndpointServiceResult>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<EndpointServiceResult>[]): EndpointServiceResult[]
  • concat(...items: (T | ConcatArray<T>)[]): EndpointServiceResult[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<EndpointServiceResult>[]

      Additional items to add to the end of array1.

    Returns EndpointServiceResult[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns EndpointServiceResult[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, EndpointServiceResult]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, EndpointServiceResult]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: EndpointServiceResult, index: number, array: EndpointServiceResult[]): boolean
        • Parameters

          • value: EndpointServiceResult
          • index: number
          • array: EndpointServiceResult[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: EndpointServiceResult, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: EndpointServiceResult

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): EndpointServiceResult[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: EndpointServiceResult

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: EndpointServiceResult, index: number, array: EndpointServiceResult[]): boolean
        • Parameters

          • value: EndpointServiceResult
          • index: number
          • array: EndpointServiceResult[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: EndpointServiceResult, index: number, array: EndpointServiceResult[]): any
        • Parameters

          • value: EndpointServiceResult
          • index: number
          • array: EndpointServiceResult[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns EndpointServiceResult[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): EndpointServiceResult | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: EndpointServiceResult

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: EndpointServiceResult, index: number, obj: EndpointServiceResult[]): boolean
        • Parameters

          • this: void
          • value: EndpointServiceResult
          • index: number
          • obj: EndpointServiceResult[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: EndpointServiceResult, index: number, obj: EndpointServiceResult[]): boolean
        • Parameters

          • value: EndpointServiceResult
          • index: number
          • obj: EndpointServiceResult[]

          Returns boolean

    • Optional thisArg: any

    Returns EndpointServiceResult | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: EndpointServiceResult, index: number, obj: EndpointServiceResult[]): boolean
        • Parameters

          • value: EndpointServiceResult
          • index: number
          • obj: EndpointServiceResult[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: EndpointServiceResult, index: number, array: EndpointServiceResult[]): void
        • Parameters

          • value: EndpointServiceResult
          • index: number
          • array: EndpointServiceResult[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: EndpointServiceResult, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: EndpointServiceResult

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: EndpointServiceResult, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: EndpointServiceResult

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: EndpointServiceResult, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: EndpointServiceResult

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: EndpointServiceResult, index: number, array: EndpointServiceResult[]): U
        • Parameters

          • value: EndpointServiceResult
          • index: number
          • array: EndpointServiceResult[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): EndpointServiceResult | undefined
  • Removes the last element from an array and returns it.

    Returns EndpointServiceResult | undefined

push

  • push(...items: EndpointServiceResult[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: EndpointServiceResult[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): EndpointServiceResult
  • reduce(callbackfn: function, initialValue: EndpointServiceResult): EndpointServiceResult
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: EndpointServiceResult, currentValue: EndpointServiceResult, currentIndex: number, array: EndpointServiceResult[]): EndpointServiceResult
        • Parameters

          • previousValue: EndpointServiceResult
          • currentValue: EndpointServiceResult
          • currentIndex: number
          • array: EndpointServiceResult[]

          Returns EndpointServiceResult

    Returns EndpointServiceResult

  • Parameters

    • callbackfn: function
        • (previousValue: EndpointServiceResult, currentValue: EndpointServiceResult, currentIndex: number, array: EndpointServiceResult[]): EndpointServiceResult
        • Parameters

          • previousValue: EndpointServiceResult
          • currentValue: EndpointServiceResult
          • currentIndex: number
          • array: EndpointServiceResult[]

          Returns EndpointServiceResult

    • initialValue: EndpointServiceResult

    Returns EndpointServiceResult

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: EndpointServiceResult, currentIndex: number, array: EndpointServiceResult[]): U
        • Parameters

          • previousValue: U
          • currentValue: EndpointServiceResult
          • currentIndex: number
          • array: EndpointServiceResult[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): EndpointServiceResult
  • reduceRight(callbackfn: function, initialValue: EndpointServiceResult): EndpointServiceResult
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: EndpointServiceResult, currentValue: EndpointServiceResult, currentIndex: number, array: EndpointServiceResult[]): EndpointServiceResult
        • Parameters

          • previousValue: EndpointServiceResult
          • currentValue: EndpointServiceResult
          • currentIndex: number
          • array: EndpointServiceResult[]

          Returns EndpointServiceResult

    Returns EndpointServiceResult

  • Parameters

    • callbackfn: function
        • (previousValue: EndpointServiceResult, currentValue: EndpointServiceResult, currentIndex: number, array: EndpointServiceResult[]): EndpointServiceResult
        • Parameters

          • previousValue: EndpointServiceResult
          • currentValue: EndpointServiceResult
          • currentIndex: number
          • array: EndpointServiceResult[]

          Returns EndpointServiceResult

    • initialValue: EndpointServiceResult

    Returns EndpointServiceResult

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: EndpointServiceResult, currentIndex: number, array: EndpointServiceResult[]): U
        • Parameters

          • previousValue: U
          • currentValue: EndpointServiceResult
          • currentIndex: number
          • array: EndpointServiceResult[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): EndpointServiceResult[]
  • Reverses the elements in an Array.

    Returns EndpointServiceResult[]

shift

  • shift(): EndpointServiceResult | undefined
  • Removes the first element from an array and returns it.

    Returns EndpointServiceResult | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): EndpointServiceResult[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns EndpointServiceResult[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: EndpointServiceResult, index: number, array: EndpointServiceResult[]): boolean
        • Parameters

          • value: EndpointServiceResult
          • index: number
          • array: EndpointServiceResult[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): EndpointServiceResult[]
  • splice(start: number, deleteCount: number, ...items: EndpointServiceResult[]): EndpointServiceResult[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns EndpointServiceResult[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: EndpointServiceResult[]

      Elements to insert into the array in place of the deleted elements.

    Returns EndpointServiceResult[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: EndpointServiceResult[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: EndpointServiceResult[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<EndpointServiceResult>
  • Returns an iterable of values in the array

    Returns IterableIterator<EndpointServiceResult>

type

type: object

className

className: string = "EndpointServicesListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "EndpointServiceResult"

name

name: "Composite" = "Composite"

Const ErrorDetails

ErrorDetails: object

Common error details representation.

Optional code

code: undefined | string

Error code.

Optional message

message: undefined | string

Error message.

serializedName

serializedName: string = "ErrorDetails"

Optional target

target: undefined | string

Error target.

type

type: object

className

className: string = "ErrorDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

target

target: object

serializedName

serializedName: string = "target"

type

type: object

name

name: "String" = "String"

Const ErrorModel

ErrorModel: object

Common error representation.

Optional code

code: undefined | string

Error code.

Optional details

details: ErrorDetails[]

Error details.

Optional innerError

innerError: undefined | string

Inner error message.

Optional message

message: undefined | string

Error message.

serializedName

serializedName: string = "Error"

Optional target

target: undefined | string

Error target.

type

type: object

className

className: string = "ErrorModel"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

details

details: object

serializedName

serializedName: string = "details"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ErrorDetails"

name

name: "Composite" = "Composite"

innerError

innerError: object

serializedName

serializedName: string = "innerError"

type

type: object

name

name: "String" = "String"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

target

target: object

serializedName

serializedName: string = "target"

type

type: object

name

name: "String" = "String"

Const ErrorResponse

ErrorResponse: object

The error object.

Optional error

Error. The error details object.

serializedName

serializedName: string = "ErrorResponse"

type

type: object

className

className: string = "ErrorResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

error

error: object

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "ErrorDetails"

name

name: "Composite" = "Composite"

Const EvaluatedNetworkSecurityGroup

EvaluatedNetworkSecurityGroup: object

Results of network security group evaluation.

Optional appliedTo

appliedTo: undefined | string

Resource ID of nic or subnet to which network security group is applied.

Optional matchedRule

matchedRule: MatchedRule

Matched network security rule.

Optional networkSecurityGroupId

networkSecurityGroupId: undefined | string

Network security group ID.

Optional rulesEvaluationResult

rulesEvaluationResult: NetworkSecurityRulesEvaluationResult[]

List of network security rules evaluation results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "EvaluatedNetworkSecurityGroup"

type

type: object

className

className: string = "EvaluatedNetworkSecurityGroup"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

appliedTo

appliedTo: object

serializedName

serializedName: string = "appliedTo"

type

type: object

name

name: "String" = "String"

matchedRule

matchedRule: object

serializedName

serializedName: string = "matchedRule"

type

type: object

className

className: string = "MatchedRule"

name

name: "Composite" = "Composite"

networkSecurityGroupId

networkSecurityGroupId: object

serializedName

serializedName: string = "networkSecurityGroupId"

type

type: object

name

name: "String" = "String"

rulesEvaluationResult

rulesEvaluationResult: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "rulesEvaluationResult"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NetworkSecurityRulesEvaluationResult"

name

name: "Composite" = "Composite"

Const ExpressRouteCircuit

ExpressRouteCircuit: object

ExpressRouteCircuit resource.

Optional allowClassicOperations

allowClassicOperations: undefined | false | true

Allow classic operations.

Optional authorizations

authorizations: ExpressRouteCircuitAuthorization[]

The list of authorizations.

Optional bandwidthInGbps

bandwidthInGbps: undefined | number

The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource.

Optional circuitProvisioningState

circuitProvisioningState: undefined | string

The CircuitProvisioningState state of the resource.

Optional etag

etag: undefined | string

Gets a unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

Optional expressRoutePort

expressRoutePort: SubResource

The reference to the ExpressRoutePort resource when the circuit is provisioned on an ExpressRoutePort resource.

Optional gatewayManagerEtag

gatewayManagerEtag: undefined | string

The GatewayManager Etag.

Optional globalReachEnabled

globalReachEnabled: undefined | false | true

Flag denoting Global reach status.

Optional id

id: undefined | string

Resource ID.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional peerings

peerings: ExpressRouteCircuitPeering[]

The list of peerings.

Optional provisioningState

provisioningState: undefined | string

Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

serializedName

serializedName: string = "ExpressRouteCircuit"

Optional serviceKey

serviceKey: undefined | string

The ServiceKey.

Optional serviceProviderNotes

serviceProviderNotes: undefined | string

The ServiceProviderNotes.

Optional serviceProviderProperties

The ServiceProviderProperties.

Optional serviceProviderProvisioningState

serviceProviderProvisioningState: ServiceProviderProvisioningState

The ServiceProviderProvisioningState state of the resource. Possible values include: 'NotProvisioned', 'Provisioning', 'Provisioned', 'Deprovisioning'

Optional sku

The SKU.

Optional stag

stag: undefined | number

The identifier of the circuit traffic. Outer tag for QinQ encapsulation. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object

Resource tags.

type

type: object

className

className: string = "ExpressRouteCircuit"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

allowClassicOperations

allowClassicOperations: object

serializedName

serializedName: string = "properties.allowClassicOperations"

type

type: object

name

name: "Boolean" = "Boolean"

authorizations

authorizations: object

serializedName

serializedName: string = "properties.authorizations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ExpressRouteCircuitAuthorization"

name

name: "Composite" = "Composite"

bandwidthInGbps

bandwidthInGbps: object

serializedName

serializedName: string = "properties.bandwidthInGbps"

type

type: object

name

name: "Number" = "Number"

circuitProvisioningState

circuitProvisioningState: object

serializedName

serializedName: string = "properties.circuitProvisioningState"

type

type: object

name

name: "String" = "String"

etag

etag: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

expressRoutePort

expressRoutePort: object

serializedName

serializedName: string = "properties.expressRoutePort"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

gatewayManagerEtag

gatewayManagerEtag: object

serializedName

serializedName: string = "properties.gatewayManagerEtag"

type

type: object

name

name: "String" = "String"

globalReachEnabled

globalReachEnabled: object

serializedName

serializedName: string = "properties.globalReachEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

peerings

peerings: object

serializedName

serializedName: string = "properties.peerings"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ExpressRouteCircuitPeering"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

serviceKey

serviceKey: object

serializedName

serializedName: string = "properties.serviceKey"

type

type: object

name

name: "String" = "String"

serviceProviderNotes

serviceProviderNotes: object

serializedName

serializedName: string = "properties.serviceProviderNotes"

type

type: object

name

name: "String" = "String"

serviceProviderProperties

serviceProviderProperties: object

serializedName

serializedName: string = "properties.serviceProviderProperties"

type

type: object

className

className: string = "ExpressRouteCircuitServiceProviderProperties"

name

name: "Composite" = "Composite"

serviceProviderProvisioningState

serviceProviderProvisioningState: object

serializedName

serializedName: string = "properties.serviceProviderProvisioningState"

type

type: object

name

name: "String" = "String"

sku

sku: object

serializedName

serializedName: string = "sku"

type

type: object

className

className: string = "ExpressRouteCircuitSku"

name

name: "Composite" = "Composite"

stag

stag: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.stag"

type

type: object

name

name: "Number" = "Number"

Const ExpressRouteCircuitArpTable

ExpressRouteCircuitArpTable: object

The ARP table associated with the ExpressRouteCircuit.

Optional age

age: undefined | number

Entry age in minutes.

Optional interfaceProperty

interfaceProperty: undefined | string

Interface address.

Optional ipAddress

ipAddress: undefined | string

The IP address.

Optional macAddress

macAddress: undefined | string

The MAC address.

serializedName

serializedName: string = "ExpressRouteCircuitArpTable"

type

type: object

className

className: string = "ExpressRouteCircuitArpTable"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

age

age: object

serializedName

serializedName: string = "age"

type

type: object

name

name: "Number" = "Number"

interfaceProperty

interfaceProperty: object

serializedName

serializedName: string = "interface"

type

type: object

name

name: "String" = "String"

ipAddress

ipAddress: object

serializedName

serializedName: string = "ipAddress"

type

type: object

name

name: "String" = "String"

macAddress

macAddress: object

serializedName

serializedName: string = "macAddress"

type

type: object

name

name: "String" = "String"

Const ExpressRouteCircuitAuthorization

ExpressRouteCircuitAuthorization: object

Authorization in an ExpressRouteCircuit resource.

Optional authorizationKey

authorizationKey: undefined | string

The authorization key.

Optional authorizationUseStatus

authorizationUseStatus: AuthorizationUseStatus

The authorization use status. Possible values include: 'Available', 'InUse'

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

Gets name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional provisioningState

provisioningState: undefined | string

Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

serializedName

serializedName: string = "ExpressRouteCircuitAuthorization"

type

type: object

Type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "ExpressRouteCircuitAuthorization"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

authorizationKey

authorizationKey: object

serializedName

serializedName: string = "properties.authorizationKey"

type

type: object

name

name: "String" = "String"

authorizationUseStatus

authorizationUseStatus: object

serializedName

serializedName: string = "properties.authorizationUseStatus"

type

type: object

name

name: "String" = "String"

etag

etag: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const ExpressRouteCircuitConnection

ExpressRouteCircuitConnection: object

Express Route Circuit Connection in an ExpressRouteCircuitPeering resource.

Optional addressPrefix

addressPrefix: undefined | string

/29 IP address space to carve out Customer addresses for tunnels.

Optional authorizationKey

authorizationKey: undefined | string

The authorization key.

Optional circuitConnectionStatus

circuitConnectionStatus: CircuitConnectionStatus

Express Route Circuit connection state. Possible values include: 'Connected', 'Connecting', 'Disconnected'

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

Optional expressRouteCircuitPeering

expressRouteCircuitPeering: SubResource

Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

Gets name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional peerExpressRouteCircuitPeering

peerExpressRouteCircuitPeering: SubResource

Reference to Express Route Circuit Private Peering Resource of the peered circuit.

Optional provisioningState

provisioningState: undefined | string

Provisioning state of the circuit connection resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ExpressRouteCircuitConnection"

type

type: object

Type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "ExpressRouteCircuitConnection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

addressPrefix

addressPrefix: object

serializedName

serializedName: string = "properties.addressPrefix"

type

type: object

name

name: "String" = "String"

authorizationKey

authorizationKey: object

serializedName

serializedName: string = "properties.authorizationKey"

type

type: object

name

name: "String" = "String"

circuitConnectionStatus

circuitConnectionStatus: object

serializedName

serializedName: string = "properties.circuitConnectionStatus"

type

type: object

name

name: "String" = "String"

etag

etag: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

expressRouteCircuitPeering

expressRouteCircuitPeering: object

serializedName

serializedName: string = "properties.expressRouteCircuitPeering"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

peerExpressRouteCircuitPeering

peerExpressRouteCircuitPeering: object

serializedName

serializedName: string = "properties.peerExpressRouteCircuitPeering"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const ExpressRouteCircuitConnectionListResult

ExpressRouteCircuitConnectionListResult: object
interface

Response for ListConnections API service call retrieves all global reach connections that belongs to a Private Peering for an ExpressRouteCircuit.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "ExpressRouteCircuitConnectionListResult"

__@iterator

  • __@iterator(): IterableIterator<ExpressRouteCircuitConnection>
  • Iterator

    Returns IterableIterator<ExpressRouteCircuitConnection>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ExpressRouteCircuitConnection>[]): ExpressRouteCircuitConnection[]
  • concat(...items: (T | ConcatArray<T>)[]): ExpressRouteCircuitConnection[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ExpressRouteCircuitConnection>[]

      Additional items to add to the end of array1.

    Returns ExpressRouteCircuitConnection[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ExpressRouteCircuitConnection[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ExpressRouteCircuitConnection]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ExpressRouteCircuitConnection]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ExpressRouteCircuitConnection, index: number, array: ExpressRouteCircuitConnection[]): boolean
        • Parameters

          • value: ExpressRouteCircuitConnection
          • index: number
          • array: ExpressRouteCircuitConnection[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ExpressRouteCircuitConnection, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ExpressRouteCircuitConnection

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ExpressRouteCircuitConnection[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ExpressRouteCircuitConnection

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ExpressRouteCircuitConnection, index: number, array: ExpressRouteCircuitConnection[]): boolean
        • Parameters

          • value: ExpressRouteCircuitConnection
          • index: number
          • array: ExpressRouteCircuitConnection[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ExpressRouteCircuitConnection, index: number, array: ExpressRouteCircuitConnection[]): any
        • Parameters

          • value: ExpressRouteCircuitConnection
          • index: number
          • array: ExpressRouteCircuitConnection[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ExpressRouteCircuitConnection[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ExpressRouteCircuitConnection | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ExpressRouteCircuitConnection

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ExpressRouteCircuitConnection, index: number, obj: ExpressRouteCircuitConnection[]): boolean
        • Parameters

          • this: void
          • value: ExpressRouteCircuitConnection
          • index: number
          • obj: ExpressRouteCircuitConnection[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ExpressRouteCircuitConnection, index: number, obj: ExpressRouteCircuitConnection[]): boolean
        • Parameters

          • value: ExpressRouteCircuitConnection
          • index: number
          • obj: ExpressRouteCircuitConnection[]

          Returns boolean

    • Optional thisArg: any

    Returns ExpressRouteCircuitConnection | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ExpressRouteCircuitConnection, index: number, obj: ExpressRouteCircuitConnection[]): boolean
        • Parameters

          • value: ExpressRouteCircuitConnection
          • index: number
          • obj: ExpressRouteCircuitConnection[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ExpressRouteCircuitConnection, index: number, array: ExpressRouteCircuitConnection[]): void
        • Parameters

          • value: ExpressRouteCircuitConnection
          • index: number
          • array: ExpressRouteCircuitConnection[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ExpressRouteCircuitConnection, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ExpressRouteCircuitConnection

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ExpressRouteCircuitConnection, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ExpressRouteCircuitConnection

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ExpressRouteCircuitConnection, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ExpressRouteCircuitConnection

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ExpressRouteCircuitConnection, index: number, array: ExpressRouteCircuitConnection[]): U
        • Parameters

          • value: ExpressRouteCircuitConnection
          • index: number
          • array: ExpressRouteCircuitConnection[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ExpressRouteCircuitConnection | undefined
  • Removes the last element from an array and returns it.

    Returns ExpressRouteCircuitConnection | undefined

push

  • push(...items: ExpressRouteCircuitConnection[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ExpressRouteCircuitConnection[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ExpressRouteCircuitConnection
  • reduce(callbackfn: function, initialValue: ExpressRouteCircuitConnection): ExpressRouteCircuitConnection
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ExpressRouteCircuitConnection, currentValue: ExpressRouteCircuitConnection, currentIndex: number, array: ExpressRouteCircuitConnection[]): ExpressRouteCircuitConnection
        • Parameters

          • previousValue: ExpressRouteCircuitConnection
          • currentValue: ExpressRouteCircuitConnection
          • currentIndex: number
          • array: ExpressRouteCircuitConnection[]

          Returns ExpressRouteCircuitConnection

    Returns ExpressRouteCircuitConnection

  • Parameters

    • callbackfn: function
        • (previousValue: ExpressRouteCircuitConnection, currentValue: ExpressRouteCircuitConnection, currentIndex: number, array: ExpressRouteCircuitConnection[]): ExpressRouteCircuitConnection
        • Parameters

          • previousValue: ExpressRouteCircuitConnection
          • currentValue: ExpressRouteCircuitConnection
          • currentIndex: number
          • array: ExpressRouteCircuitConnection[]

          Returns ExpressRouteCircuitConnection

    • initialValue: ExpressRouteCircuitConnection

    Returns ExpressRouteCircuitConnection

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ExpressRouteCircuitConnection, currentIndex: number, array: ExpressRouteCircuitConnection[]): U
        • Parameters

          • previousValue: U
          • currentValue: ExpressRouteCircuitConnection
          • currentIndex: number
          • array: ExpressRouteCircuitConnection[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ExpressRouteCircuitConnection
  • reduceRight(callbackfn: function, initialValue: ExpressRouteCircuitConnection): ExpressRouteCircuitConnection
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ExpressRouteCircuitConnection, currentValue: ExpressRouteCircuitConnection, currentIndex: number, array: ExpressRouteCircuitConnection[]): ExpressRouteCircuitConnection
        • Parameters

          • previousValue: ExpressRouteCircuitConnection
          • currentValue: ExpressRouteCircuitConnection
          • currentIndex: number
          • array: ExpressRouteCircuitConnection[]

          Returns ExpressRouteCircuitConnection

    Returns ExpressRouteCircuitConnection

  • Parameters

    • callbackfn: function
        • (previousValue: ExpressRouteCircuitConnection, currentValue: ExpressRouteCircuitConnection, currentIndex: number, array: ExpressRouteCircuitConnection[]): ExpressRouteCircuitConnection
        • Parameters

          • previousValue: ExpressRouteCircuitConnection
          • currentValue: ExpressRouteCircuitConnection
          • currentIndex: number
          • array: ExpressRouteCircuitConnection[]

          Returns ExpressRouteCircuitConnection

    • initialValue: ExpressRouteCircuitConnection

    Returns ExpressRouteCircuitConnection

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ExpressRouteCircuitConnection, currentIndex: number, array: ExpressRouteCircuitConnection[]): U
        • Parameters

          • previousValue: U
          • currentValue: ExpressRouteCircuitConnection
          • currentIndex: number
          • array: ExpressRouteCircuitConnection[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ExpressRouteCircuitConnection[]
  • Reverses the elements in an Array.

    Returns ExpressRouteCircuitConnection[]

shift

  • shift(): ExpressRouteCircuitConnection | undefined
  • Removes the first element from an array and returns it.

    Returns ExpressRouteCircuitConnection | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ExpressRouteCircuitConnection[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ExpressRouteCircuitConnection[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ExpressRouteCircuitConnection, index: number, array: ExpressRouteCircuitConnection[]): boolean
        • Parameters

          • value: ExpressRouteCircuitConnection
          • index: number
          • array: ExpressRouteCircuitConnection[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ExpressRouteCircuitConnection[]
  • splice(start: number, deleteCount: number, ...items: ExpressRouteCircuitConnection[]): ExpressRouteCircuitConnection[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ExpressRouteCircuitConnection[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ExpressRouteCircuitConnection[]

      Elements to insert into the array in place of the deleted elements.

    Returns ExpressRouteCircuitConnection[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ExpressRouteCircuitConnection[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ExpressRouteCircuitConnection[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ExpressRouteCircuitConnection>
  • Returns an iterable of values in the array

    Returns IterableIterator<ExpressRouteCircuitConnection>

type

type: object

className

className: string = "ExpressRouteCircuitConnectionListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ExpressRouteCircuitConnection"

name

name: "Composite" = "Composite"

Const ExpressRouteCircuitListResult

ExpressRouteCircuitListResult: object
interface

Response for ListExpressRouteCircuit API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "ExpressRouteCircuitListResult"

__@iterator

  • __@iterator(): IterableIterator<ExpressRouteCircuit>
  • Iterator

    Returns IterableIterator<ExpressRouteCircuit>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ExpressRouteCircuit>[]): ExpressRouteCircuit[]
  • concat(...items: (T | ConcatArray<T>)[]): ExpressRouteCircuit[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ExpressRouteCircuit>[]

      Additional items to add to the end of array1.

    Returns ExpressRouteCircuit[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ExpressRouteCircuit[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ExpressRouteCircuit]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ExpressRouteCircuit]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ExpressRouteCircuit, index: number, array: ExpressRouteCircuit[]): boolean
        • Parameters

          • value: ExpressRouteCircuit
          • index: number
          • array: ExpressRouteCircuit[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ExpressRouteCircuit, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ExpressRouteCircuit

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ExpressRouteCircuit[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ExpressRouteCircuit

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ExpressRouteCircuit, index: number, array: ExpressRouteCircuit[]): boolean
        • Parameters

          • value: ExpressRouteCircuit
          • index: number
          • array: ExpressRouteCircuit[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ExpressRouteCircuit, index: number, array: ExpressRouteCircuit[]): any
        • Parameters

          • value: ExpressRouteCircuit
          • index: number
          • array: ExpressRouteCircuit[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ExpressRouteCircuit[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ExpressRouteCircuit | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ExpressRouteCircuit

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ExpressRouteCircuit, index: number, obj: ExpressRouteCircuit[]): boolean
        • Parameters

          • this: void
          • value: ExpressRouteCircuit
          • index: number
          • obj: ExpressRouteCircuit[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ExpressRouteCircuit, index: number, obj: ExpressRouteCircuit[]): boolean
        • Parameters

          • value: ExpressRouteCircuit
          • index: number
          • obj: ExpressRouteCircuit[]

          Returns boolean

    • Optional thisArg: any

    Returns ExpressRouteCircuit | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ExpressRouteCircuit, index: number, obj: ExpressRouteCircuit[]): boolean
        • Parameters

          • value: ExpressRouteCircuit
          • index: number
          • obj: ExpressRouteCircuit[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ExpressRouteCircuit, index: number, array: ExpressRouteCircuit[]): void
        • Parameters

          • value: ExpressRouteCircuit
          • index: number
          • array: ExpressRouteCircuit[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ExpressRouteCircuit, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ExpressRouteCircuit

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ExpressRouteCircuit, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ExpressRouteCircuit

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ExpressRouteCircuit, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ExpressRouteCircuit

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ExpressRouteCircuit, index: number, array: ExpressRouteCircuit[]): U
        • Parameters

          • value: ExpressRouteCircuit
          • index: number
          • array: ExpressRouteCircuit[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ExpressRouteCircuit | undefined
  • Removes the last element from an array and returns it.

    Returns ExpressRouteCircuit | undefined

push

  • push(...items: ExpressRouteCircuit[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ExpressRouteCircuit[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ExpressRouteCircuit
  • reduce(callbackfn: function, initialValue: ExpressRouteCircuit): ExpressRouteCircuit
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ExpressRouteCircuit, currentValue: ExpressRouteCircuit, currentIndex: number, array: ExpressRouteCircuit[]): ExpressRouteCircuit
        • Parameters

          • previousValue: ExpressRouteCircuit
          • currentValue: ExpressRouteCircuit
          • currentIndex: number
          • array: ExpressRouteCircuit[]

          Returns ExpressRouteCircuit

    Returns ExpressRouteCircuit

  • Parameters

    • callbackfn: function
        • (previousValue: ExpressRouteCircuit, currentValue: ExpressRouteCircuit, currentIndex: number, array: ExpressRouteCircuit[]): ExpressRouteCircuit
        • Parameters

          • previousValue: ExpressRouteCircuit
          • currentValue: ExpressRouteCircuit
          • currentIndex: number
          • array: ExpressRouteCircuit[]

          Returns ExpressRouteCircuit

    • initialValue: ExpressRouteCircuit

    Returns ExpressRouteCircuit

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ExpressRouteCircuit, currentIndex: number, array: ExpressRouteCircuit[]): U
        • Parameters

          • previousValue: U
          • currentValue: ExpressRouteCircuit
          • currentIndex: number
          • array: ExpressRouteCircuit[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ExpressRouteCircuit
  • reduceRight(callbackfn: function, initialValue: ExpressRouteCircuit): ExpressRouteCircuit
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ExpressRouteCircuit, currentValue: ExpressRouteCircuit, currentIndex: number, array: ExpressRouteCircuit[]): ExpressRouteCircuit
        • Parameters

          • previousValue: ExpressRouteCircuit
          • currentValue: ExpressRouteCircuit
          • currentIndex: number
          • array: ExpressRouteCircuit[]

          Returns ExpressRouteCircuit

    Returns ExpressRouteCircuit

  • Parameters

    • callbackfn: function
        • (previousValue: ExpressRouteCircuit, currentValue: ExpressRouteCircuit, currentIndex: number, array: ExpressRouteCircuit[]): ExpressRouteCircuit
        • Parameters

          • previousValue: ExpressRouteCircuit
          • currentValue: ExpressRouteCircuit
          • currentIndex: number
          • array: ExpressRouteCircuit[]

          Returns ExpressRouteCircuit

    • initialValue: ExpressRouteCircuit

    Returns ExpressRouteCircuit

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ExpressRouteCircuit, currentIndex: number, array: ExpressRouteCircuit[]): U
        • Parameters

          • previousValue: U
          • currentValue: ExpressRouteCircuit
          • currentIndex: number
          • array: ExpressRouteCircuit[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ExpressRouteCircuit[]
  • Reverses the elements in an Array.

    Returns ExpressRouteCircuit[]

shift

  • shift(): ExpressRouteCircuit | undefined
  • Removes the first element from an array and returns it.

    Returns ExpressRouteCircuit | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ExpressRouteCircuit[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ExpressRouteCircuit[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ExpressRouteCircuit, index: number, array: ExpressRouteCircuit[]): boolean
        • Parameters

          • value: ExpressRouteCircuit
          • index: number
          • array: ExpressRouteCircuit[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ExpressRouteCircuit[]
  • splice(start: number, deleteCount: number, ...items: ExpressRouteCircuit[]): ExpressRouteCircuit[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ExpressRouteCircuit[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ExpressRouteCircuit[]

      Elements to insert into the array in place of the deleted elements.

    Returns ExpressRouteCircuit[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ExpressRouteCircuit[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ExpressRouteCircuit[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ExpressRouteCircuit>
  • Returns an iterable of values in the array

    Returns IterableIterator<ExpressRouteCircuit>

type

type: object

className

className: string = "ExpressRouteCircuitListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ExpressRouteCircuit"

name

name: "Composite" = "Composite"

Const ExpressRouteCircuitPeering

ExpressRouteCircuitPeering: object

Peering in an ExpressRouteCircuit resource.

Optional azureASN

azureASN: undefined | number

The Azure ASN.

Optional connections

connections: ExpressRouteCircuitConnection[]

The list of circuit connections associated with Azure Private Peering for this circuit.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

Optional expressRouteConnection

expressRouteConnection: ExpressRouteConnectionId

The ExpressRoute connection.

Optional gatewayManagerEtag

gatewayManagerEtag: undefined | string

The GatewayManager Etag.

Optional id

id: undefined | string

Resource ID.

Optional ipv6PeeringConfig

The IPv6 peering configuration.

Optional lastModifiedBy

lastModifiedBy: undefined | string

Gets whether the provider or the customer last modified the peering.

Optional microsoftPeeringConfig

microsoftPeeringConfig: ExpressRouteCircuitPeeringConfig

The Microsoft peering configuration.

Optional name

name: undefined | string

Gets name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional peerASN

peerASN: undefined | number

The peer ASN.

Optional peeredConnections

peeredConnections: PeerExpressRouteCircuitConnection[]

The list of peered circuit connections associated with Azure Private Peering for this circuit. NOTE: This property will not be serialized. It can only be populated by the server.

Optional peeringType

The peering type. Possible values include: 'AzurePublicPeering', 'AzurePrivatePeering', 'MicrosoftPeering'

Optional primaryAzurePort

primaryAzurePort: undefined | string

The primary port.

Optional primaryPeerAddressPrefix

primaryPeerAddressPrefix: undefined | string

The primary address prefix.

Optional provisioningState

provisioningState: undefined | string

Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

Optional routeFilter

routeFilter: SubResource

The reference of the RouteFilter resource.

Optional secondaryAzurePort

secondaryAzurePort: undefined | string

The secondary port.

Optional secondaryPeerAddressPrefix

secondaryPeerAddressPrefix: undefined | string

The secondary address prefix.

serializedName

serializedName: string = "ExpressRouteCircuitPeering"

Optional sharedKey

sharedKey: undefined | string

The shared key.

Optional state

The peering state. Possible values include: 'Disabled', 'Enabled'

Optional stats

Gets peering stats.

Optional vlanId

vlanId: undefined | number

The VLAN ID.

type

type: object

Type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "ExpressRouteCircuitPeering"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

azureASN

azureASN: object

serializedName

serializedName: string = "properties.azureASN"

type

type: object

name

name: "Number" = "Number"

connections

connections: object

serializedName

serializedName: string = "properties.connections"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ExpressRouteCircuitConnection"

name

name: "Composite" = "Composite"

etag

etag: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

expressRouteConnection

expressRouteConnection: object

serializedName

serializedName: string = "properties.expressRouteConnection"

type

type: object

className

className: string = "ExpressRouteConnectionId"

name

name: "Composite" = "Composite"

gatewayManagerEtag

gatewayManagerEtag: object

serializedName

serializedName: string = "properties.gatewayManagerEtag"

type

type: object

name

name: "String" = "String"

ipv6PeeringConfig

ipv6PeeringConfig: object

serializedName

serializedName: string = "properties.ipv6PeeringConfig"

type

type: object

className

className: string = "Ipv6ExpressRouteCircuitPeeringConfig"

name

name: "Composite" = "Composite"

lastModifiedBy

lastModifiedBy: object

serializedName

serializedName: string = "properties.lastModifiedBy"

type

type: object

name

name: "String" = "String"

microsoftPeeringConfig

microsoftPeeringConfig: object

serializedName

serializedName: string = "properties.microsoftPeeringConfig"

type

type: object

className

className: string = "ExpressRouteCircuitPeeringConfig"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

peerASN

peerASN: object

serializedName

serializedName: string = "properties.peerASN"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 4294967295

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: "Number" = "Number"

peeredConnections

peeredConnections: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.peeredConnections"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PeerExpressRouteCircuitConnection"

name

name: "Composite" = "Composite"

peeringType

peeringType: object

serializedName

serializedName: string = "properties.peeringType"

type

type: object

name

name: "String" = "String"

primaryAzurePort

primaryAzurePort: object

serializedName

serializedName: string = "properties.primaryAzurePort"

type

type: object

name

name: "String" = "String"

primaryPeerAddressPrefix

primaryPeerAddressPrefix: object

serializedName

serializedName: string = "properties.primaryPeerAddressPrefix"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

routeFilter

routeFilter: object

serializedName

serializedName: string = "properties.routeFilter"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

secondaryAzurePort

secondaryAzurePort: object

serializedName

serializedName: string = "properties.secondaryAzurePort"

type

type: object

name

name: "String" = "String"

secondaryPeerAddressPrefix

secondaryPeerAddressPrefix: object

serializedName

serializedName: string = "properties.secondaryPeerAddressPrefix"

type

type: object

name

name: "String" = "String"

sharedKey

sharedKey: object

serializedName

serializedName: string = "properties.sharedKey"

type

type: object

name

name: "String" = "String"

state

state: object

serializedName

serializedName: string = "properties.state"

type

type: object

name

name: "String" = "String"

stats

stats: object

serializedName

serializedName: string = "properties.stats"

type

type: object

className

className: string = "ExpressRouteCircuitStats"

name

name: "Composite" = "Composite"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

vlanId

vlanId: object

serializedName

serializedName: string = "properties.vlanId"

type

type: object

name

name: "Number" = "Number"

Const ExpressRouteCircuitPeeringConfig

ExpressRouteCircuitPeeringConfig: object

Specifies the peering configuration.

Optional advertisedCommunities

advertisedCommunities: string[]

The communities of bgp peering. Specified for microsoft peering.

Optional advertisedPublicPrefixes

advertisedPublicPrefixes: string[]

The reference of AdvertisedPublicPrefixes.

Optional advertisedPublicPrefixesState

The advertised public prefix state of the Peering resource. Possible values include: 'NotConfigured', 'Configuring', 'Configured', 'ValidationNeeded'

Optional customerASN

customerASN: undefined | number

The CustomerASN of the peering.

Optional legacyMode

legacyMode: undefined | number

The legacy mode of the peering.

Optional routingRegistryName

routingRegistryName: undefined | string

The RoutingRegistryName of the configuration.

serializedName

serializedName: string = "ExpressRouteCircuitPeeringConfig"

type

type: object

className

className: string = "ExpressRouteCircuitPeeringConfig"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

advertisedCommunities

advertisedCommunities: object

serializedName

serializedName: string = "advertisedCommunities"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

advertisedPublicPrefixes

advertisedPublicPrefixes: object

serializedName

serializedName: string = "advertisedPublicPrefixes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

advertisedPublicPrefixesState

advertisedPublicPrefixesState: object

serializedName

serializedName: string = "advertisedPublicPrefixesState"

type

type: object

name

name: "String" = "String"

customerASN

customerASN: object

serializedName

serializedName: string = "customerASN"

type

type: object

name

name: "Number" = "Number"

legacyMode

legacyMode: object

serializedName

serializedName: string = "legacyMode"

type

type: object

name

name: "Number" = "Number"

routingRegistryName

routingRegistryName: object

serializedName

serializedName: string = "routingRegistryName"

type

type: object

name

name: "String" = "String"

Const ExpressRouteCircuitPeeringId

ExpressRouteCircuitPeeringId: object

ExpressRoute circuit peering identifier.

Optional id

id: undefined | string

The ID of the ExpressRoute circuit peering.

serializedName

serializedName: string = "ExpressRouteCircuitPeeringId"

type

type: object

className

className: string = "ExpressRouteCircuitPeeringId"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

Const ExpressRouteCircuitPeeringListResult

ExpressRouteCircuitPeeringListResult: object
interface

Response for ListPeering API service call retrieves all peerings that belong to an ExpressRouteCircuit.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "ExpressRouteCircuitPeeringListResult"

__@iterator

  • __@iterator(): IterableIterator<ExpressRouteCircuitPeering>
  • Iterator

    Returns IterableIterator<ExpressRouteCircuitPeering>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ExpressRouteCircuitPeering>[]): ExpressRouteCircuitPeering[]
  • concat(...items: (T | ConcatArray<T>)[]): ExpressRouteCircuitPeering[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ExpressRouteCircuitPeering>[]

      Additional items to add to the end of array1.

    Returns ExpressRouteCircuitPeering[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ExpressRouteCircuitPeering[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ExpressRouteCircuitPeering]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ExpressRouteCircuitPeering]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ExpressRouteCircuitPeering, index: number, array: ExpressRouteCircuitPeering[]): boolean
        • Parameters

          • value: ExpressRouteCircuitPeering
          • index: number
          • array: ExpressRouteCircuitPeering[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ExpressRouteCircuitPeering, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ExpressRouteCircuitPeering

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ExpressRouteCircuitPeering[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ExpressRouteCircuitPeering

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ExpressRouteCircuitPeering, index: number, array: ExpressRouteCircuitPeering[]): boolean
        • Parameters

          • value: ExpressRouteCircuitPeering
          • index: number
          • array: ExpressRouteCircuitPeering[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ExpressRouteCircuitPeering, index: number, array: ExpressRouteCircuitPeering[]): any
        • Parameters

          • value: ExpressRouteCircuitPeering
          • index: number
          • array: ExpressRouteCircuitPeering[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ExpressRouteCircuitPeering[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ExpressRouteCircuitPeering | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ExpressRouteCircuitPeering

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ExpressRouteCircuitPeering, index: number, obj: ExpressRouteCircuitPeering[]): boolean
        • Parameters

          • this: void
          • value: ExpressRouteCircuitPeering
          • index: number
          • obj: ExpressRouteCircuitPeering[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ExpressRouteCircuitPeering, index: number, obj: ExpressRouteCircuitPeering[]): boolean
        • Parameters

          • value: ExpressRouteCircuitPeering
          • index: number
          • obj: ExpressRouteCircuitPeering[]

          Returns boolean

    • Optional thisArg: any

    Returns ExpressRouteCircuitPeering | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ExpressRouteCircuitPeering, index: number, obj: ExpressRouteCircuitPeering[]): boolean
        • Parameters

          • value: ExpressRouteCircuitPeering
          • index: number
          • obj: ExpressRouteCircuitPeering[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ExpressRouteCircuitPeering, index: number, array: ExpressRouteCircuitPeering[]): void
        • Parameters

          • value: ExpressRouteCircuitPeering
          • index: number
          • array: ExpressRouteCircuitPeering[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ExpressRouteCircuitPeering, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ExpressRouteCircuitPeering

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ExpressRouteCircuitPeering, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ExpressRouteCircuitPeering

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ExpressRouteCircuitPeering, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ExpressRouteCircuitPeering

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ExpressRouteCircuitPeering, index: number, array: ExpressRouteCircuitPeering[]): U
        • Parameters

          • value: ExpressRouteCircuitPeering
          • index: number
          • array: ExpressRouteCircuitPeering[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ExpressRouteCircuitPeering | undefined
  • Removes the last element from an array and returns it.

    Returns ExpressRouteCircuitPeering | undefined

push

  • push(...items: ExpressRouteCircuitPeering[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ExpressRouteCircuitPeering[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ExpressRouteCircuitPeering
  • reduce(callbackfn: function, initialValue: ExpressRouteCircuitPeering): ExpressRouteCircuitPeering
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ExpressRouteCircuitPeering, currentValue: ExpressRouteCircuitPeering, currentIndex: number, array: ExpressRouteCircuitPeering[]): ExpressRouteCircuitPeering
        • Parameters

          • previousValue: ExpressRouteCircuitPeering
          • currentValue: ExpressRouteCircuitPeering
          • currentIndex: number
          • array: ExpressRouteCircuitPeering[]

          Returns ExpressRouteCircuitPeering

    Returns ExpressRouteCircuitPeering

  • Parameters

    • callbackfn: function
        • (previousValue: ExpressRouteCircuitPeering, currentValue: ExpressRouteCircuitPeering, currentIndex: number, array: ExpressRouteCircuitPeering[]): ExpressRouteCircuitPeering
        • Parameters

          • previousValue: ExpressRouteCircuitPeering
          • currentValue: ExpressRouteCircuitPeering
          • currentIndex: number
          • array: ExpressRouteCircuitPeering[]

          Returns ExpressRouteCircuitPeering

    • initialValue: ExpressRouteCircuitPeering

    Returns ExpressRouteCircuitPeering

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ExpressRouteCircuitPeering, currentIndex: number, array: ExpressRouteCircuitPeering[]): U
        • Parameters

          • previousValue: U
          • currentValue: ExpressRouteCircuitPeering
          • currentIndex: number
          • array: ExpressRouteCircuitPeering[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ExpressRouteCircuitPeering
  • reduceRight(callbackfn: function, initialValue: ExpressRouteCircuitPeering): ExpressRouteCircuitPeering
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ExpressRouteCircuitPeering, currentValue: ExpressRouteCircuitPeering, currentIndex: number, array: ExpressRouteCircuitPeering[]): ExpressRouteCircuitPeering
        • Parameters

          • previousValue: ExpressRouteCircuitPeering
          • currentValue: ExpressRouteCircuitPeering
          • currentIndex: number
          • array: ExpressRouteCircuitPeering[]

          Returns ExpressRouteCircuitPeering

    Returns ExpressRouteCircuitPeering

  • Parameters

    • callbackfn: function
        • (previousValue: ExpressRouteCircuitPeering, currentValue: ExpressRouteCircuitPeering, currentIndex: number, array: ExpressRouteCircuitPeering[]): ExpressRouteCircuitPeering
        • Parameters

          • previousValue: ExpressRouteCircuitPeering
          • currentValue: ExpressRouteCircuitPeering
          • currentIndex: number
          • array: ExpressRouteCircuitPeering[]

          Returns ExpressRouteCircuitPeering

    • initialValue: ExpressRouteCircuitPeering

    Returns ExpressRouteCircuitPeering

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ExpressRouteCircuitPeering, currentIndex: number, array: ExpressRouteCircuitPeering[]): U
        • Parameters

          • previousValue: U
          • currentValue: ExpressRouteCircuitPeering
          • currentIndex: number
          • array: ExpressRouteCircuitPeering[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ExpressRouteCircuitPeering[]
  • Reverses the elements in an Array.

    Returns ExpressRouteCircuitPeering[]

shift

  • shift(): ExpressRouteCircuitPeering | undefined
  • Removes the first element from an array and returns it.

    Returns ExpressRouteCircuitPeering | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ExpressRouteCircuitPeering[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ExpressRouteCircuitPeering[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ExpressRouteCircuitPeering, index: number, array: ExpressRouteCircuitPeering[]): boolean
        • Parameters

          • value: ExpressRouteCircuitPeering
          • index: number
          • array: ExpressRouteCircuitPeering[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ExpressRouteCircuitPeering[]
  • splice(start: number, deleteCount: number, ...items: ExpressRouteCircuitPeering[]): ExpressRouteCircuitPeering[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ExpressRouteCircuitPeering[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ExpressRouteCircuitPeering[]

      Elements to insert into the array in place of the deleted elements.

    Returns ExpressRouteCircuitPeering[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ExpressRouteCircuitPeering[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ExpressRouteCircuitPeering[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ExpressRouteCircuitPeering>
  • Returns an iterable of values in the array

    Returns IterableIterator<ExpressRouteCircuitPeering>

type

type: object

className

className: string = "ExpressRouteCircuitPeeringListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ExpressRouteCircuitPeering"

name

name: "Composite" = "Composite"

Const ExpressRouteCircuitReference

ExpressRouteCircuitReference: object

Reference to an express route circuit.

Optional id

id: undefined | string

Corresponding Express Route Circuit Id.

serializedName

serializedName: string = "ExpressRouteCircuitReference"

type

type: object

className

className: string = "ExpressRouteCircuitReference"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

Const ExpressRouteCircuitRoutesTable

ExpressRouteCircuitRoutesTable: object

The routes table associated with the ExpressRouteCircuit.

Optional locPrf

locPrf: undefined | string

Local preference value as set with the set local-preference route-map configuration command.

Optional network

network: undefined | string

IP address of a network entity.

Optional nextHop

nextHop: undefined | string

NextHop address.

Optional path

path: undefined | string

Autonomous system paths to the destination network.

serializedName

serializedName: string = "ExpressRouteCircuitRoutesTable"

Optional weight

weight: undefined | number

Route Weight.

type

type: object

className

className: string = "ExpressRouteCircuitRoutesTable"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

locPrf

locPrf: object

serializedName

serializedName: string = "locPrf"

type

type: object

name

name: "String" = "String"

network

network: object

serializedName

serializedName: string = "network"

type

type: object

name

name: "String" = "String"

nextHop

nextHop: object

serializedName

serializedName: string = "nextHop"

type

type: object

name

name: "String" = "String"

path

path: object

serializedName

serializedName: string = "path"

type

type: object

name

name: "String" = "String"

weight

weight: object

serializedName

serializedName: string = "weight"

type

type: object

name

name: "Number" = "Number"

Const ExpressRouteCircuitRoutesTableSummary

ExpressRouteCircuitRoutesTableSummary: object

The routes table associated with the ExpressRouteCircuit.

Optional as

as: undefined | number

Autonomous system number.

Optional neighbor

neighbor: undefined | string

IP address of the neighbor.

serializedName

serializedName: string = "ExpressRouteCircuitRoutesTableSummary"

Optional statePfxRcd

statePfxRcd: undefined | string

Current state of the BGP session, and the number of prefixes that have been received from a neighbor or peer group.

Optional upDown

upDown: undefined | string

The length of time that the BGP session has been in the Established state, or the current status if not in the Established state.

Optional v

v: undefined | number

BGP version number spoken to the neighbor.

type

type: object

className

className: string = "ExpressRouteCircuitRoutesTableSummary"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

as

as: object

serializedName

serializedName: string = "as"

type

type: object

name

name: "Number" = "Number"

neighbor

neighbor: object

serializedName

serializedName: string = "neighbor"

type

type: object

name

name: "String" = "String"

statePfxRcd

statePfxRcd: object

serializedName

serializedName: string = "statePfxRcd"

type

type: object

name

name: "String" = "String"

upDown

upDown: object

serializedName

serializedName: string = "upDown"

type

type: object

name

name: "String" = "String"

v

v: object

serializedName

serializedName: string = "v"

type

type: object

name

name: "Number" = "Number"

Const ExpressRouteCircuitServiceProviderProperties

ExpressRouteCircuitServiceProviderProperties: object

Contains ServiceProviderProperties in an ExpressRouteCircuit.

Optional bandwidthInMbps

bandwidthInMbps: undefined | number

The BandwidthInMbps.

Optional peeringLocation

peeringLocation: undefined | string

The peering location.

serializedName

serializedName: string = "ExpressRouteCircuitServiceProviderProperties"

Optional serviceProviderName

serviceProviderName: undefined | string

The serviceProviderName.

type

type: object

className

className: string = "ExpressRouteCircuitServiceProviderProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

bandwidthInMbps

bandwidthInMbps: object

serializedName

serializedName: string = "bandwidthInMbps"

type

type: object

name

name: "Number" = "Number"

peeringLocation

peeringLocation: object

serializedName

serializedName: string = "peeringLocation"

type

type: object

name

name: "String" = "String"

serviceProviderName

serviceProviderName: object

serializedName

serializedName: string = "serviceProviderName"

type

type: object

name

name: "String" = "String"

Const ExpressRouteCircuitSku

ExpressRouteCircuitSku: object

Contains SKU in an ExpressRouteCircuit.

Optional family

The family of the SKU. Possible values include: 'UnlimitedData', 'MeteredData'

Optional name

name: undefined | string

The name of the SKU.

serializedName

serializedName: string = "ExpressRouteCircuitSku"

Optional tier

The tier of the SKU. Possible values include: 'Standard', 'Premium', 'Basic', 'Local'

type

type: object

className

className: string = "ExpressRouteCircuitSku"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

family

family: object

serializedName

serializedName: string = "family"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

tier

tier: object

serializedName

serializedName: string = "tier"

type

type: object

name

name: "String" = "String"

Const ExpressRouteCircuitStats

ExpressRouteCircuitStats: object

Contains stats associated with the peering.

Optional primarybytesIn

primarybytesIn: undefined | number

Gets BytesIn of the peering.

Optional primarybytesOut

primarybytesOut: undefined | number

Gets BytesOut of the peering.

Optional secondarybytesIn

secondarybytesIn: undefined | number

Gets BytesIn of the peering.

Optional secondarybytesOut

secondarybytesOut: undefined | number

Gets BytesOut of the peering.

serializedName

serializedName: string = "ExpressRouteCircuitStats"

type

type: object

className

className: string = "ExpressRouteCircuitStats"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

primarybytesIn

primarybytesIn: object

serializedName

serializedName: string = "primarybytesIn"

type

type: object

name

name: "Number" = "Number"

primarybytesOut

primarybytesOut: object

serializedName

serializedName: string = "primarybytesOut"

type

type: object

name

name: "Number" = "Number"

secondarybytesIn

secondarybytesIn: object

serializedName

serializedName: string = "secondarybytesIn"

type

type: object

name

name: "Number" = "Number"

secondarybytesOut

secondarybytesOut: object

serializedName

serializedName: string = "secondarybytesOut"

type

type: object

name

name: "Number" = "Number"

Const ExpressRouteCircuitsArpTableListResult

ExpressRouteCircuitsArpTableListResult: object

Response for ListArpTable associated with the Express Route Circuits API.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "ExpressRouteCircuitsArpTableListResult"

Optional value

value: ExpressRouteCircuitArpTable[]

Gets list of the ARP table.

type

type: object

className

className: string = "ExpressRouteCircuitsArpTableListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ExpressRouteCircuitArpTable"

name

name: "Composite" = "Composite"

Const ExpressRouteCircuitsRoutesTableListResult

ExpressRouteCircuitsRoutesTableListResult: object

Response for ListRoutesTable associated with the Express Route Circuits API.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "ExpressRouteCircuitsRoutesTableListResult"

Optional value

value: ExpressRouteCircuitRoutesTable[]

The list of routes table.

type

type: object

className

className: string = "ExpressRouteCircuitsRoutesTableListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ExpressRouteCircuitRoutesTable"

name

name: "Composite" = "Composite"

Const ExpressRouteCircuitsRoutesTableSummaryListResult

ExpressRouteCircuitsRoutesTableSummaryListResult: object

Response for ListRoutesTable associated with the Express Route Circuits API.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "ExpressRouteCircuitsRoutesTableSummaryListResult"

Optional value

value: ExpressRouteCircuitRoutesTableSummary[]

A list of the routes table.

type

type: object

className

className: string = "ExpressRouteCircuitsRoutesTableSummaryListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ExpressRouteCircuitRoutesTableSummary"

name

name: "Composite" = "Composite"

Const ExpressRouteConnection

ExpressRouteConnection: object

ExpressRouteConnection resource.

Optional authorizationKey

authorizationKey: undefined | string

Authorization key to establish the connection.

expressRouteCircuitPeering

expressRouteCircuitPeering: ExpressRouteCircuitPeeringId

The ExpressRoute circuit peering.

Optional id

id: undefined | string

Resource ID.

name

name: string

The name of the resource.

Optional provisioningState

provisioningState: ProvisioningState

The provisioning state of the resource. Possible values include: 'Succeeded', 'Updating', 'Deleting', 'Failed'

Optional routingWeight

routingWeight: undefined | number

The routing weight associated to the connection.

serializedName

serializedName: string = "ExpressRouteConnection"

type

type: object

className

className: string = "ExpressRouteConnection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

authorizationKey

authorizationKey: object

serializedName

serializedName: string = "properties.authorizationKey"

type

type: object

name

name: "String" = "String"

expressRouteCircuitPeering

expressRouteCircuitPeering: object

required

required: true = true

serializedName

serializedName: string = "properties.expressRouteCircuitPeering"

type

type: object

className

className: string = "ExpressRouteCircuitPeeringId"

name

name: "Composite" = "Composite"

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

routingWeight

routingWeight: object

serializedName

serializedName: string = "properties.routingWeight"

type

type: object

name

name: "Number" = "Number"

Const ExpressRouteConnectionId

ExpressRouteConnectionId: object

The ID of the ExpressRouteConnection.

Optional id

id: undefined | string

The ID of the ExpressRouteConnection. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ExpressRouteConnectionId"

type

type: object

className

className: string = "ExpressRouteConnectionId"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

Const ExpressRouteConnectionList

ExpressRouteConnectionList: object

ExpressRouteConnection list.

serializedName

serializedName: string = "ExpressRouteConnectionList"

Optional value

value: ExpressRouteConnection[]

The list of ExpressRoute connections.

type

type: object

className

className: string = "ExpressRouteConnectionList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ExpressRouteConnection"

name

name: "Composite" = "Composite"

Const ExpressRouteCrossConnection

ExpressRouteCrossConnection: object

ExpressRouteCrossConnection resource.

Optional bandwidthInMbps

bandwidthInMbps: undefined | number

The circuit bandwidth In Mbps.

Optional etag

etag: undefined | string

Gets a unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

Optional expressRouteCircuit

expressRouteCircuit: ExpressRouteCircuitReference

The ExpressRouteCircuit.

Optional id

id: undefined | string

Resource ID.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional peeringLocation

peeringLocation: undefined | string

The peering location of the ExpressRoute circuit.

Optional peerings

peerings: ExpressRouteCrossConnectionPeering[]

The list of peerings.

Optional primaryAzurePort

primaryAzurePort: undefined | string

The name of the primary port. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string

Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. NOTE: This property will not be serialized. It can only be populated by the server.

Optional sTag

sTag: undefined | number

The identifier of the circuit traffic. NOTE: This property will not be serialized. It can only be populated by the server.

Optional secondaryAzurePort

secondaryAzurePort: undefined | string

The name of the secondary port. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ExpressRouteCrossConnection"

Optional serviceProviderNotes

serviceProviderNotes: undefined | string

Additional read only notes set by the connectivity provider.

Optional serviceProviderProvisioningState

serviceProviderProvisioningState: ServiceProviderProvisioningState

The provisioning state of the circuit in the connectivity provider system. Possible values include: 'NotProvisioned', 'Provisioning', 'Provisioned', 'Deprovisioning'

Optional tags

tags: undefined | object

Resource tags.

type

type: object

className

className: string = "ExpressRouteCrossConnection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

bandwidthInMbps

bandwidthInMbps: object

serializedName

serializedName: string = "properties.bandwidthInMbps"

type

type: object

name

name: "Number" = "Number"

etag

etag: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

expressRouteCircuit

expressRouteCircuit: object

serializedName

serializedName: string = "properties.expressRouteCircuit"

type

type: object

className

className: string = "ExpressRouteCircuitReference"

name

name: "Composite" = "Composite"

peeringLocation

peeringLocation: object

serializedName

serializedName: string = "properties.peeringLocation"

type

type: object

name

name: "String" = "String"

peerings

peerings: object

serializedName

serializedName: string = "properties.peerings"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ExpressRouteCrossConnectionPeering"

name

name: "Composite" = "Composite"

primaryAzurePort

primaryAzurePort: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.primaryAzurePort"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

sTag

sTag: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.sTag"

type

type: object

name

name: "Number" = "Number"

secondaryAzurePort

secondaryAzurePort: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.secondaryAzurePort"

type

type: object

name

name: "String" = "String"

serviceProviderNotes

serviceProviderNotes: object

serializedName

serializedName: string = "properties.serviceProviderNotes"

type

type: object

name

name: "String" = "String"

serviceProviderProvisioningState

serviceProviderProvisioningState: object

serializedName

serializedName: string = "properties.serviceProviderProvisioningState"

type

type: object

name

name: "String" = "String"

Const ExpressRouteCrossConnectionListResult

ExpressRouteCrossConnectionListResult: object
interface

Response for ListExpressRouteCrossConnection API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ExpressRouteCrossConnectionListResult"

__@iterator

  • __@iterator(): IterableIterator<ExpressRouteCrossConnection>
  • Iterator

    Returns IterableIterator<ExpressRouteCrossConnection>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ExpressRouteCrossConnection>[]): ExpressRouteCrossConnection[]
  • concat(...items: (T | ConcatArray<T>)[]): ExpressRouteCrossConnection[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ExpressRouteCrossConnection>[]

      Additional items to add to the end of array1.

    Returns ExpressRouteCrossConnection[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ExpressRouteCrossConnection[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ExpressRouteCrossConnection]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ExpressRouteCrossConnection]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ExpressRouteCrossConnection, index: number, array: ExpressRouteCrossConnection[]): boolean
        • Parameters

          • value: ExpressRouteCrossConnection
          • index: number
          • array: ExpressRouteCrossConnection[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ExpressRouteCrossConnection, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ExpressRouteCrossConnection

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ExpressRouteCrossConnection[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ExpressRouteCrossConnection

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ExpressRouteCrossConnection, index: number, array: ExpressRouteCrossConnection[]): boolean
        • Parameters

          • value: ExpressRouteCrossConnection
          • index: number
          • array: ExpressRouteCrossConnection[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ExpressRouteCrossConnection, index: number, array: ExpressRouteCrossConnection[]): any
        • Parameters

          • value: ExpressRouteCrossConnection
          • index: number
          • array: ExpressRouteCrossConnection[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ExpressRouteCrossConnection[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ExpressRouteCrossConnection | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ExpressRouteCrossConnection

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ExpressRouteCrossConnection, index: number, obj: ExpressRouteCrossConnection[]): boolean
        • Parameters

          • this: void
          • value: ExpressRouteCrossConnection
          • index: number
          • obj: ExpressRouteCrossConnection[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ExpressRouteCrossConnection, index: number, obj: ExpressRouteCrossConnection[]): boolean
        • Parameters

          • value: ExpressRouteCrossConnection
          • index: number
          • obj: ExpressRouteCrossConnection[]

          Returns boolean

    • Optional thisArg: any

    Returns ExpressRouteCrossConnection | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ExpressRouteCrossConnection, index: number, obj: ExpressRouteCrossConnection[]): boolean
        • Parameters

          • value: ExpressRouteCrossConnection
          • index: number
          • obj: ExpressRouteCrossConnection[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ExpressRouteCrossConnection, index: number, array: ExpressRouteCrossConnection[]): void
        • Parameters

          • value: ExpressRouteCrossConnection
          • index: number
          • array: ExpressRouteCrossConnection[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ExpressRouteCrossConnection, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ExpressRouteCrossConnection

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ExpressRouteCrossConnection, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ExpressRouteCrossConnection

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ExpressRouteCrossConnection, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ExpressRouteCrossConnection

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ExpressRouteCrossConnection, index: number, array: ExpressRouteCrossConnection[]): U
        • Parameters

          • value: ExpressRouteCrossConnection
          • index: number
          • array: ExpressRouteCrossConnection[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ExpressRouteCrossConnection | undefined
  • Removes the last element from an array and returns it.

    Returns ExpressRouteCrossConnection | undefined

push

  • push(...items: ExpressRouteCrossConnection[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ExpressRouteCrossConnection[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ExpressRouteCrossConnection
  • reduce(callbackfn: function, initialValue: ExpressRouteCrossConnection): ExpressRouteCrossConnection
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ExpressRouteCrossConnection, currentValue: ExpressRouteCrossConnection, currentIndex: number, array: ExpressRouteCrossConnection[]): ExpressRouteCrossConnection
        • Parameters

          • previousValue: ExpressRouteCrossConnection
          • currentValue: ExpressRouteCrossConnection
          • currentIndex: number
          • array: ExpressRouteCrossConnection[]

          Returns ExpressRouteCrossConnection

    Returns ExpressRouteCrossConnection

  • Parameters

    • callbackfn: function
        • (previousValue: ExpressRouteCrossConnection, currentValue: ExpressRouteCrossConnection, currentIndex: number, array: ExpressRouteCrossConnection[]): ExpressRouteCrossConnection
        • Parameters

          • previousValue: ExpressRouteCrossConnection
          • currentValue: ExpressRouteCrossConnection
          • currentIndex: number
          • array: ExpressRouteCrossConnection[]

          Returns ExpressRouteCrossConnection

    • initialValue: ExpressRouteCrossConnection

    Returns ExpressRouteCrossConnection

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ExpressRouteCrossConnection, currentIndex: number, array: ExpressRouteCrossConnection[]): U
        • Parameters

          • previousValue: U
          • currentValue: ExpressRouteCrossConnection
          • currentIndex: number
          • array: ExpressRouteCrossConnection[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ExpressRouteCrossConnection
  • reduceRight(callbackfn: function, initialValue: ExpressRouteCrossConnection): ExpressRouteCrossConnection
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ExpressRouteCrossConnection, currentValue: ExpressRouteCrossConnection, currentIndex: number, array: ExpressRouteCrossConnection[]): ExpressRouteCrossConnection
        • Parameters

          • previousValue: ExpressRouteCrossConnection
          • currentValue: ExpressRouteCrossConnection
          • currentIndex: number
          • array: ExpressRouteCrossConnection[]

          Returns ExpressRouteCrossConnection

    Returns ExpressRouteCrossConnection

  • Parameters

    • callbackfn: function
        • (previousValue: ExpressRouteCrossConnection, currentValue: ExpressRouteCrossConnection, currentIndex: number, array: ExpressRouteCrossConnection[]): ExpressRouteCrossConnection
        • Parameters

          • previousValue: ExpressRouteCrossConnection
          • currentValue: ExpressRouteCrossConnection
          • currentIndex: number
          • array: ExpressRouteCrossConnection[]

          Returns ExpressRouteCrossConnection

    • initialValue: ExpressRouteCrossConnection

    Returns ExpressRouteCrossConnection

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ExpressRouteCrossConnection, currentIndex: number, array: ExpressRouteCrossConnection[]): U
        • Parameters

          • previousValue: U
          • currentValue: ExpressRouteCrossConnection
          • currentIndex: number
          • array: ExpressRouteCrossConnection[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ExpressRouteCrossConnection[]
  • Reverses the elements in an Array.

    Returns ExpressRouteCrossConnection[]

shift

  • shift(): ExpressRouteCrossConnection | undefined
  • Removes the first element from an array and returns it.

    Returns ExpressRouteCrossConnection | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ExpressRouteCrossConnection[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ExpressRouteCrossConnection[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ExpressRouteCrossConnection, index: number, array: ExpressRouteCrossConnection[]): boolean
        • Parameters

          • value: ExpressRouteCrossConnection
          • index: number
          • array: ExpressRouteCrossConnection[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ExpressRouteCrossConnection[]
  • splice(start: number, deleteCount: number, ...items: ExpressRouteCrossConnection[]): ExpressRouteCrossConnection[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ExpressRouteCrossConnection[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ExpressRouteCrossConnection[]

      Elements to insert into the array in place of the deleted elements.

    Returns ExpressRouteCrossConnection[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ExpressRouteCrossConnection[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ExpressRouteCrossConnection[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ExpressRouteCrossConnection>
  • Returns an iterable of values in the array

    Returns IterableIterator<ExpressRouteCrossConnection>

type

type: object

className

className: string = "ExpressRouteCrossConnectionListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ExpressRouteCrossConnection"

name

name: "Composite" = "Composite"

Const ExpressRouteCrossConnectionPeering

ExpressRouteCrossConnectionPeering: object

Peering in an ExpressRoute Cross Connection resource.

Optional azureASN

azureASN: undefined | number

The Azure ASN. NOTE: This property will not be serialized. It can only be populated by the server.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

Optional gatewayManagerEtag

gatewayManagerEtag: undefined | string

The GatewayManager Etag.

Optional id

id: undefined | string

Resource ID.

Optional ipv6PeeringConfig

The IPv6 peering configuration.

Optional lastModifiedBy

lastModifiedBy: undefined | string

Gets whether the provider or the customer last modified the peering.

Optional microsoftPeeringConfig

microsoftPeeringConfig: ExpressRouteCircuitPeeringConfig

The Microsoft peering configuration.

Optional name

name: undefined | string

Gets name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional peerASN

peerASN: undefined | number

The peer ASN.

Optional peeringType

The peering type. Possible values include: 'AzurePublicPeering', 'AzurePrivatePeering', 'MicrosoftPeering'

Optional primaryAzurePort

primaryAzurePort: undefined | string

The primary port. NOTE: This property will not be serialized. It can only be populated by the server.

Optional primaryPeerAddressPrefix

primaryPeerAddressPrefix: undefined | string

The primary address prefix.

Optional provisioningState

provisioningState: undefined | string

Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. NOTE: This property will not be serialized. It can only be populated by the server.

Optional secondaryAzurePort

secondaryAzurePort: undefined | string

The secondary port. NOTE: This property will not be serialized. It can only be populated by the server.

Optional secondaryPeerAddressPrefix

secondaryPeerAddressPrefix: undefined | string

The secondary address prefix.

serializedName

serializedName: string = "ExpressRouteCrossConnectionPeering"

Optional sharedKey

sharedKey: undefined | string

The shared key.

Optional state

The peering state. Possible values include: 'Disabled', 'Enabled'

Optional vlanId

vlanId: undefined | number

The VLAN ID.

type

type: object

className

className: string = "ExpressRouteCrossConnectionPeering"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

azureASN

azureASN: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.azureASN"

type

type: object

name

name: "Number" = "Number"

etag

etag: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

gatewayManagerEtag

gatewayManagerEtag: object

serializedName

serializedName: string = "properties.gatewayManagerEtag"

type

type: object

name

name: "String" = "String"

ipv6PeeringConfig

ipv6PeeringConfig: object

serializedName

serializedName: string = "properties.ipv6PeeringConfig"

type

type: object

className

className: string = "Ipv6ExpressRouteCircuitPeeringConfig"

name

name: "Composite" = "Composite"

lastModifiedBy

lastModifiedBy: object

serializedName

serializedName: string = "properties.lastModifiedBy"

type

type: object

name

name: "String" = "String"

microsoftPeeringConfig

microsoftPeeringConfig: object

serializedName

serializedName: string = "properties.microsoftPeeringConfig"

type

type: object

className

className: string = "ExpressRouteCircuitPeeringConfig"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

peerASN

peerASN: object

serializedName

serializedName: string = "properties.peerASN"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 4294967295

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: "Number" = "Number"

peeringType

peeringType: object

serializedName

serializedName: string = "properties.peeringType"

type

type: object

name

name: "String" = "String"

primaryAzurePort

primaryAzurePort: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.primaryAzurePort"

type

type: object

name

name: "String" = "String"

primaryPeerAddressPrefix

primaryPeerAddressPrefix: object

serializedName

serializedName: string = "properties.primaryPeerAddressPrefix"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

secondaryAzurePort

secondaryAzurePort: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.secondaryAzurePort"

type

type: object

name

name: "String" = "String"

secondaryPeerAddressPrefix

secondaryPeerAddressPrefix: object

serializedName

serializedName: string = "properties.secondaryPeerAddressPrefix"

type

type: object

name

name: "String" = "String"

sharedKey

sharedKey: object

serializedName

serializedName: string = "properties.sharedKey"

type

type: object

name

name: "String" = "String"

state

state: object

serializedName

serializedName: string = "properties.state"

type

type: object

name

name: "String" = "String"

vlanId

vlanId: object

serializedName

serializedName: string = "properties.vlanId"

type

type: object

name

name: "Number" = "Number"

Const ExpressRouteCrossConnectionPeeringList

ExpressRouteCrossConnectionPeeringList: object
interface

Response for ListPeering API service call retrieves all peerings that belong to an ExpressRouteCrossConnection.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ExpressRouteCrossConnectionPeeringList"

__@iterator

  • __@iterator(): IterableIterator<ExpressRouteCrossConnectionPeering>
  • Iterator

    Returns IterableIterator<ExpressRouteCrossConnectionPeering>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ExpressRouteCrossConnectionPeering>[]): ExpressRouteCrossConnectionPeering[]
  • concat(...items: (T | ConcatArray<T>)[]): ExpressRouteCrossConnectionPeering[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ExpressRouteCrossConnectionPeering>[]

      Additional items to add to the end of array1.

    Returns ExpressRouteCrossConnectionPeering[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ExpressRouteCrossConnectionPeering[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ExpressRouteCrossConnectionPeering]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ExpressRouteCrossConnectionPeering]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ExpressRouteCrossConnectionPeering, index: number, array: ExpressRouteCrossConnectionPeering[]): boolean
        • Parameters

          • value: ExpressRouteCrossConnectionPeering
          • index: number
          • array: ExpressRouteCrossConnectionPeering[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ExpressRouteCrossConnectionPeering, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ExpressRouteCrossConnectionPeering

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ExpressRouteCrossConnectionPeering[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ExpressRouteCrossConnectionPeering

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ExpressRouteCrossConnectionPeering, index: number, array: ExpressRouteCrossConnectionPeering[]): boolean
        • Parameters

          • value: ExpressRouteCrossConnectionPeering
          • index: number
          • array: ExpressRouteCrossConnectionPeering[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ExpressRouteCrossConnectionPeering, index: number, array: ExpressRouteCrossConnectionPeering[]): any
        • Parameters

          • value: ExpressRouteCrossConnectionPeering
          • index: number
          • array: ExpressRouteCrossConnectionPeering[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ExpressRouteCrossConnectionPeering[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ExpressRouteCrossConnectionPeering | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ExpressRouteCrossConnectionPeering

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ExpressRouteCrossConnectionPeering, index: number, obj: ExpressRouteCrossConnectionPeering[]): boolean
        • Parameters

          • this: void
          • value: ExpressRouteCrossConnectionPeering
          • index: number
          • obj: ExpressRouteCrossConnectionPeering[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ExpressRouteCrossConnectionPeering, index: number, obj: ExpressRouteCrossConnectionPeering[]): boolean
        • Parameters

          • value: ExpressRouteCrossConnectionPeering
          • index: number
          • obj: ExpressRouteCrossConnectionPeering[]

          Returns boolean

    • Optional thisArg: any

    Returns ExpressRouteCrossConnectionPeering | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ExpressRouteCrossConnectionPeering, index: number, obj: ExpressRouteCrossConnectionPeering[]): boolean
        • Parameters

          • value: ExpressRouteCrossConnectionPeering
          • index: number
          • obj: ExpressRouteCrossConnectionPeering[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ExpressRouteCrossConnectionPeering, index: number, array: ExpressRouteCrossConnectionPeering[]): void
        • Parameters

          • value: ExpressRouteCrossConnectionPeering
          • index: number
          • array: ExpressRouteCrossConnectionPeering[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ExpressRouteCrossConnectionPeering, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ExpressRouteCrossConnectionPeering

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ExpressRouteCrossConnectionPeering, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ExpressRouteCrossConnectionPeering

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ExpressRouteCrossConnectionPeering, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ExpressRouteCrossConnectionPeering

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ExpressRouteCrossConnectionPeering, index: number, array: ExpressRouteCrossConnectionPeering[]): U
        • Parameters

          • value: ExpressRouteCrossConnectionPeering
          • index: number
          • array: ExpressRouteCrossConnectionPeering[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ExpressRouteCrossConnectionPeering | undefined
  • Removes the last element from an array and returns it.

    Returns ExpressRouteCrossConnectionPeering | undefined

push

  • push(...items: ExpressRouteCrossConnectionPeering[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ExpressRouteCrossConnectionPeering[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ExpressRouteCrossConnectionPeering
  • reduce(callbackfn: function, initialValue: ExpressRouteCrossConnectionPeering): ExpressRouteCrossConnectionPeering
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ExpressRouteCrossConnectionPeering, currentValue: ExpressRouteCrossConnectionPeering, currentIndex: number, array: ExpressRouteCrossConnectionPeering[]): ExpressRouteCrossConnectionPeering
        • Parameters

          • previousValue: ExpressRouteCrossConnectionPeering
          • currentValue: ExpressRouteCrossConnectionPeering
          • currentIndex: number
          • array: ExpressRouteCrossConnectionPeering[]

          Returns ExpressRouteCrossConnectionPeering

    Returns ExpressRouteCrossConnectionPeering

  • Parameters

    • callbackfn: function
        • (previousValue: ExpressRouteCrossConnectionPeering, currentValue: ExpressRouteCrossConnectionPeering, currentIndex: number, array: ExpressRouteCrossConnectionPeering[]): ExpressRouteCrossConnectionPeering
        • Parameters

          • previousValue: ExpressRouteCrossConnectionPeering
          • currentValue: ExpressRouteCrossConnectionPeering
          • currentIndex: number
          • array: ExpressRouteCrossConnectionPeering[]

          Returns ExpressRouteCrossConnectionPeering

    • initialValue: ExpressRouteCrossConnectionPeering

    Returns ExpressRouteCrossConnectionPeering

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ExpressRouteCrossConnectionPeering, currentIndex: number, array: ExpressRouteCrossConnectionPeering[]): U
        • Parameters

          • previousValue: U
          • currentValue: ExpressRouteCrossConnectionPeering
          • currentIndex: number
          • array: ExpressRouteCrossConnectionPeering[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ExpressRouteCrossConnectionPeering
  • reduceRight(callbackfn: function, initialValue: ExpressRouteCrossConnectionPeering): ExpressRouteCrossConnectionPeering
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ExpressRouteCrossConnectionPeering, currentValue: ExpressRouteCrossConnectionPeering, currentIndex: number, array: ExpressRouteCrossConnectionPeering[]): ExpressRouteCrossConnectionPeering
        • Parameters

          • previousValue: ExpressRouteCrossConnectionPeering
          • currentValue: ExpressRouteCrossConnectionPeering
          • currentIndex: number
          • array: ExpressRouteCrossConnectionPeering[]

          Returns ExpressRouteCrossConnectionPeering

    Returns ExpressRouteCrossConnectionPeering

  • Parameters

    • callbackfn: function
        • (previousValue: ExpressRouteCrossConnectionPeering, currentValue: ExpressRouteCrossConnectionPeering, currentIndex: number, array: ExpressRouteCrossConnectionPeering[]): ExpressRouteCrossConnectionPeering
        • Parameters

          • previousValue: ExpressRouteCrossConnectionPeering
          • currentValue: ExpressRouteCrossConnectionPeering
          • currentIndex: number
          • array: ExpressRouteCrossConnectionPeering[]

          Returns ExpressRouteCrossConnectionPeering

    • initialValue: ExpressRouteCrossConnectionPeering

    Returns ExpressRouteCrossConnectionPeering

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ExpressRouteCrossConnectionPeering, currentIndex: number, array: ExpressRouteCrossConnectionPeering[]): U
        • Parameters

          • previousValue: U
          • currentValue: ExpressRouteCrossConnectionPeering
          • currentIndex: number
          • array: ExpressRouteCrossConnectionPeering[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ExpressRouteCrossConnectionPeering[]
  • Reverses the elements in an Array.

    Returns ExpressRouteCrossConnectionPeering[]

shift

  • shift(): ExpressRouteCrossConnectionPeering | undefined
  • Removes the first element from an array and returns it.

    Returns ExpressRouteCrossConnectionPeering | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ExpressRouteCrossConnectionPeering[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ExpressRouteCrossConnectionPeering[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ExpressRouteCrossConnectionPeering, index: number, array: ExpressRouteCrossConnectionPeering[]): boolean
        • Parameters

          • value: ExpressRouteCrossConnectionPeering
          • index: number
          • array: ExpressRouteCrossConnectionPeering[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ExpressRouteCrossConnectionPeering[]
  • splice(start: number, deleteCount: number, ...items: ExpressRouteCrossConnectionPeering[]): ExpressRouteCrossConnectionPeering[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ExpressRouteCrossConnectionPeering[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ExpressRouteCrossConnectionPeering[]

      Elements to insert into the array in place of the deleted elements.

    Returns ExpressRouteCrossConnectionPeering[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ExpressRouteCrossConnectionPeering[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ExpressRouteCrossConnectionPeering[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ExpressRouteCrossConnectionPeering>
  • Returns an iterable of values in the array

    Returns IterableIterator<ExpressRouteCrossConnectionPeering>

type

type: object

className

className: string = "ExpressRouteCrossConnectionPeeringList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ExpressRouteCrossConnectionPeering"

name

name: "Composite" = "Composite"

Const ExpressRouteCrossConnectionRoutesTableSummary

ExpressRouteCrossConnectionRoutesTableSummary: object

The routes table associated with the ExpressRouteCircuit.

Optional asn

asn: undefined | number

Autonomous system number.

Optional neighbor

neighbor: undefined | string

IP address of Neighbor router.

serializedName

serializedName: string = "ExpressRouteCrossConnectionRoutesTableSummary"

Optional stateOrPrefixesReceived

stateOrPrefixesReceived: undefined | string

Current state of the BGP session, and the number of prefixes that have been received from a neighbor or peer group.

Optional upDown

upDown: undefined | string

The length of time that the BGP session has been in the Established state, or the current status if not in the Established state.

type

type: object

className

className: string = "ExpressRouteCrossConnectionRoutesTableSummary"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

asn

asn: object

serializedName

serializedName: string = "asn"

type

type: object

name

name: "Number" = "Number"

neighbor

neighbor: object

serializedName

serializedName: string = "neighbor"

type

type: object

name

name: "String" = "String"

stateOrPrefixesReceived

stateOrPrefixesReceived: object

serializedName

serializedName: string = "stateOrPrefixesReceived"

type

type: object

name

name: "String" = "String"

upDown

upDown: object

serializedName

serializedName: string = "upDown"

type

type: object

name

name: "String" = "String"

Const ExpressRouteCrossConnectionsRoutesTableSummaryListResult

ExpressRouteCrossConnectionsRoutesTableSummaryListResult: object

Response for ListRoutesTable associated with the Express Route Cross Connections.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ExpressRouteCrossConnectionsRoutesTableSummaryListResult"

Optional value

value: ExpressRouteCrossConnectionRoutesTableSummary[]

A list of the routes table.

type

type: object

className

className: string = "ExpressRouteCrossConnectionsRoutesTableSummaryListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ExpressRouteCrossConnectionRoutesTableSummary"

name

name: "Composite" = "Composite"

Const ExpressRouteGateway

ExpressRouteGateway: object

ExpressRoute gateway resource.

Optional autoScaleConfiguration

Configuration for auto scaling.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

Optional expressRouteConnections

expressRouteConnections: ExpressRouteConnection[]

List of ExpressRoute connections to the ExpressRoute gateway. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: ProvisioningState

The provisioning state of the resource. Possible values include: 'Succeeded', 'Updating', 'Deleting', 'Failed'

serializedName

serializedName: string = "ExpressRouteGateway"

Optional tags

tags: undefined | object

Resource tags.

virtualHub

virtualHub: VirtualHubId

The Virtual Hub where the ExpressRoute gateway is or will be deployed.

type

type: object

className

className: string = "ExpressRouteGateway"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

autoScaleConfiguration

autoScaleConfiguration: object

serializedName

serializedName: string = "properties.autoScaleConfiguration"

type

type: object

className

className: string = "ExpressRouteGatewayPropertiesAutoScaleConfiguration"

name

name: "Composite" = "Composite"

etag

etag: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

expressRouteConnections

expressRouteConnections: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.expressRouteConnections"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ExpressRouteConnection"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

virtualHub

virtualHub: object

required

required: true = true

serializedName

serializedName: string = "properties.virtualHub"

type

type: object

className

className: string = "VirtualHubId"

name

name: "Composite" = "Composite"

Const ExpressRouteGatewayList

ExpressRouteGatewayList: object

List of ExpressRoute gateways.

serializedName

serializedName: string = "ExpressRouteGatewayList"

Optional value

value: ExpressRouteGateway[]

List of ExpressRoute gateways.

type

type: object

className

className: string = "ExpressRouteGatewayList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ExpressRouteGateway"

name

name: "Composite" = "Composite"

Const ExpressRouteGatewayPropertiesAutoScaleConfiguration

ExpressRouteGatewayPropertiesAutoScaleConfiguration: object

Configuration for auto scaling.

Optional bounds

Minimum and maximum number of scale units to deploy.

serializedName

serializedName: string = "ExpressRouteGatewayProperties_autoScaleConfiguration"

type

type: object

className

className: string = "ExpressRouteGatewayPropertiesAutoScaleConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

bounds

bounds: object

serializedName

serializedName: string = "bounds"

type

type: object

className

className: string = "ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds"

name

name: "Composite" = "Composite"

Const ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds

ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds: object

Minimum and maximum number of scale units to deploy.

Optional max

max: undefined | number

Maximum number of scale units deployed for ExpressRoute gateway.

Optional min

min: undefined | number

Minimum number of scale units deployed for ExpressRoute gateway.

serializedName

serializedName: string = "ExpressRouteGatewayProperties_autoScaleConfiguration_bounds"

type

type: object

className

className: string = "ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

max

max: object

serializedName

serializedName: string = "max"

type

type: object

name

name: "Number" = "Number"

min

min: object

serializedName

serializedName: string = "min"

type

type: object

name

name: "Number" = "Number"

Const ExpressRouteLink

ExpressRouteLink: object

ExpressRouteLink child resource definition.

summary

ExpressRouteLink

Optional adminState

Administrative state of the physical port. Possible values include: 'Enabled', 'Disabled'

Optional connectorType

Physical fiber port type. Possible values include: 'LC', 'SC' NOTE: This property will not be serialized. It can only be populated by the server.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID.

Optional interfaceName

interfaceName: undefined | string

Name of Azure router interface. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Name of child port resource that is unique among child port resources of the parent.

Optional patchPanelId

patchPanelId: undefined | string

Mapping between physical port to patch panel port. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the ExpressRouteLink resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. NOTE: This property will not be serialized. It can only be populated by the server.

Optional rackId

rackId: undefined | string

Mapping of physical patch panel to rack. NOTE: This property will not be serialized. It can only be populated by the server.

Optional routerName

routerName: undefined | string

Name of Azure router associated with physical port. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ExpressRouteLink"

type

type: object

className

className: string = "ExpressRouteLink"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

adminState

adminState: object

serializedName

serializedName: string = "properties.adminState"

type

type: object

name

name: "String" = "String"

connectorType

connectorType: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.connectorType"

type

type: object

name

name: "String" = "String"

etag

etag: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

interfaceName

interfaceName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.interfaceName"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

patchPanelId

patchPanelId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.patchPanelId"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

rackId

rackId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.rackId"

type

type: object

name

name: "String" = "String"

routerName

routerName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.routerName"

type

type: object

name

name: "String" = "String"

Const ExpressRouteLinkListResult

ExpressRouteLinkListResult: object
interface

Response for ListExpressRouteLinks API service call.

summary

ExpressRouteLink List Result

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "ExpressRouteLinkListResult"

__@iterator

  • __@iterator(): IterableIterator<ExpressRouteLink>
  • Iterator

    Returns IterableIterator<ExpressRouteLink>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ExpressRouteLink>[]): ExpressRouteLink[]
  • concat(...items: (T | ConcatArray<T>)[]): ExpressRouteLink[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ExpressRouteLink>[]

      Additional items to add to the end of array1.

    Returns ExpressRouteLink[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ExpressRouteLink[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ExpressRouteLink]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ExpressRouteLink]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ExpressRouteLink, index: number, array: ExpressRouteLink[]): boolean
        • Parameters

          • value: ExpressRouteLink
          • index: number
          • array: ExpressRouteLink[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ExpressRouteLink, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ExpressRouteLink

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ExpressRouteLink[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ExpressRouteLink

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ExpressRouteLink, index: number, array: ExpressRouteLink[]): boolean
        • Parameters

          • value: ExpressRouteLink
          • index: number
          • array: ExpressRouteLink[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ExpressRouteLink, index: number, array: ExpressRouteLink[]): any
        • Parameters

          • value: ExpressRouteLink
          • index: number
          • array: ExpressRouteLink[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ExpressRouteLink[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ExpressRouteLink | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ExpressRouteLink

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ExpressRouteLink, index: number, obj: ExpressRouteLink[]): boolean
        • Parameters

          • this: void
          • value: ExpressRouteLink
          • index: number
          • obj: ExpressRouteLink[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ExpressRouteLink, index: number, obj: ExpressRouteLink[]): boolean
        • Parameters

          • value: ExpressRouteLink
          • index: number
          • obj: ExpressRouteLink[]

          Returns boolean

    • Optional thisArg: any

    Returns ExpressRouteLink | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ExpressRouteLink, index: number, obj: ExpressRouteLink[]): boolean
        • Parameters

          • value: ExpressRouteLink
          • index: number
          • obj: ExpressRouteLink[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ExpressRouteLink, index: number, array: ExpressRouteLink[]): void
        • Parameters

          • value: ExpressRouteLink
          • index: number
          • array: ExpressRouteLink[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ExpressRouteLink, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ExpressRouteLink

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ExpressRouteLink, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ExpressRouteLink

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ExpressRouteLink, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ExpressRouteLink

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ExpressRouteLink, index: number, array: ExpressRouteLink[]): U
        • Parameters

          • value: ExpressRouteLink
          • index: number
          • array: ExpressRouteLink[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ExpressRouteLink | undefined
  • Removes the last element from an array and returns it.

    Returns ExpressRouteLink | undefined

push

  • push(...items: ExpressRouteLink[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ExpressRouteLink[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ExpressRouteLink
  • reduce(callbackfn: function, initialValue: ExpressRouteLink): ExpressRouteLink
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ExpressRouteLink, currentValue: ExpressRouteLink, currentIndex: number, array: ExpressRouteLink[]): ExpressRouteLink
        • Parameters

          • previousValue: ExpressRouteLink
          • currentValue: ExpressRouteLink
          • currentIndex: number
          • array: ExpressRouteLink[]

          Returns ExpressRouteLink

    Returns ExpressRouteLink

  • Parameters

    • callbackfn: function
        • (previousValue: ExpressRouteLink, currentValue: ExpressRouteLink, currentIndex: number, array: ExpressRouteLink[]): ExpressRouteLink
        • Parameters

          • previousValue: ExpressRouteLink
          • currentValue: ExpressRouteLink
          • currentIndex: number
          • array: ExpressRouteLink[]

          Returns ExpressRouteLink

    • initialValue: ExpressRouteLink

    Returns ExpressRouteLink

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ExpressRouteLink, currentIndex: number, array: ExpressRouteLink[]): U
        • Parameters

          • previousValue: U
          • currentValue: ExpressRouteLink
          • currentIndex: number
          • array: ExpressRouteLink[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ExpressRouteLink
  • reduceRight(callbackfn: function, initialValue: ExpressRouteLink): ExpressRouteLink
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ExpressRouteLink, currentValue: ExpressRouteLink, currentIndex: number, array: ExpressRouteLink[]): ExpressRouteLink
        • Parameters

          • previousValue: ExpressRouteLink
          • currentValue: ExpressRouteLink
          • currentIndex: number
          • array: ExpressRouteLink[]

          Returns ExpressRouteLink

    Returns ExpressRouteLink

  • Parameters

    • callbackfn: function
        • (previousValue: ExpressRouteLink, currentValue: ExpressRouteLink, currentIndex: number, array: ExpressRouteLink[]): ExpressRouteLink
        • Parameters

          • previousValue: ExpressRouteLink
          • currentValue: ExpressRouteLink
          • currentIndex: number
          • array: ExpressRouteLink[]

          Returns ExpressRouteLink

    • initialValue: ExpressRouteLink

    Returns ExpressRouteLink

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ExpressRouteLink, currentIndex: number, array: ExpressRouteLink[]): U
        • Parameters

          • previousValue: U
          • currentValue: ExpressRouteLink
          • currentIndex: number
          • array: ExpressRouteLink[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ExpressRouteLink[]
  • Reverses the elements in an Array.

    Returns ExpressRouteLink[]

shift

  • shift(): ExpressRouteLink | undefined
  • Removes the first element from an array and returns it.

    Returns ExpressRouteLink | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ExpressRouteLink[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ExpressRouteLink[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ExpressRouteLink, index: number, array: ExpressRouteLink[]): boolean
        • Parameters

          • value: ExpressRouteLink
          • index: number
          • array: ExpressRouteLink[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ExpressRouteLink[]
  • splice(start: number, deleteCount: number, ...items: ExpressRouteLink[]): ExpressRouteLink[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ExpressRouteLink[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ExpressRouteLink[]

      Elements to insert into the array in place of the deleted elements.

    Returns ExpressRouteLink[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ExpressRouteLink[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ExpressRouteLink[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ExpressRouteLink>
  • Returns an iterable of values in the array

    Returns IterableIterator<ExpressRouteLink>

type

type: object

className

className: string = "ExpressRouteLinkListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ExpressRouteLink"

name

name: "Composite" = "Composite"

Const ExpressRoutePort

ExpressRoutePort: object

ExpressRoutePort resource definition.

summary

ExpressRoute Port

Optional allocationDate

allocationDate: undefined | string

Date of the physical port allocation to be used in Letter of Authorization. NOTE: This property will not be serialized. It can only be populated by the server.

Optional bandwidthInGbps

bandwidthInGbps: undefined | number

Bandwidth of procured ports in Gbps.

Optional circuits

circuits: SubResource[]

Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional encapsulation

Encapsulation method on physical ports. Possible values include: 'Dot1Q', 'QinQ'

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

Optional etherType

etherType: undefined | string

Ether type of the physical port. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID.

Optional links

links: ExpressRouteLink[]

ExpressRouteLink Sub-Resources. The set of physical links of the ExpressRoutePort resource.

Optional location

location: undefined | string

Resource location.

Optional mtu

mtu: undefined | string

Maximum transmission unit of the physical port pair(s). NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional peeringLocation

peeringLocation: undefined | string

The name of the peering location that the ExpressRoutePort is mapped to physically.

Optional provisionedBandwidthInGbps

provisionedBandwidthInGbps: undefined | number

Aggregate Gbps of associated circuit bandwidths. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the ExpressRoutePort resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceGuid

resourceGuid: undefined | string

The resource GUID property of the ExpressRoutePort resource.

serializedName

serializedName: string = "ExpressRoutePort"

Optional tags

tags: undefined | object

Resource tags.

type

type: object

className

className: string = "ExpressRoutePort"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

allocationDate

allocationDate: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.allocationDate"

type

type: object

name

name: "String" = "String"

bandwidthInGbps

bandwidthInGbps: object

serializedName

serializedName: string = "properties.bandwidthInGbps"

type

type: object

name

name: "Number" = "Number"

circuits

circuits: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.circuits"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

encapsulation

encapsulation: object

serializedName

serializedName: string = "properties.encapsulation"

type

type: object

name

name: "String" = "String"

etag

etag: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

etherType

etherType: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.etherType"

type

type: object

name

name: "String" = "String"

links

links: object

serializedName

serializedName: string = "properties.links"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ExpressRouteLink"

name

name: "Composite" = "Composite"

mtu

mtu: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.mtu"

type

type: object

name

name: "String" = "String"

peeringLocation

peeringLocation: object

serializedName

serializedName: string = "properties.peeringLocation"

type

type: object

name

name: "String" = "String"

provisionedBandwidthInGbps

provisionedBandwidthInGbps: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisionedBandwidthInGbps"

type

type: object

name

name: "Number" = "Number"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

resourceGuid

resourceGuid: object

serializedName

serializedName: string = "properties.resourceGuid"

type

type: object

name

name: "String" = "String"

Const ExpressRoutePortListResult

ExpressRoutePortListResult: object
interface

Response for ListExpressRoutePorts API service call.

summary

ExpressRoute Port List Result

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "ExpressRoutePortListResult"

__@iterator

  • __@iterator(): IterableIterator<ExpressRoutePort>
  • Iterator

    Returns IterableIterator<ExpressRoutePort>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ExpressRoutePort>[]): ExpressRoutePort[]
  • concat(...items: (T | ConcatArray<T>)[]): ExpressRoutePort[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ExpressRoutePort>[]

      Additional items to add to the end of array1.

    Returns ExpressRoutePort[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ExpressRoutePort[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ExpressRoutePort]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ExpressRoutePort]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ExpressRoutePort, index: number, array: ExpressRoutePort[]): boolean
        • Parameters

          • value: ExpressRoutePort
          • index: number
          • array: ExpressRoutePort[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ExpressRoutePort, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ExpressRoutePort

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ExpressRoutePort[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ExpressRoutePort

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ExpressRoutePort, index: number, array: ExpressRoutePort[]): boolean
        • Parameters

          • value: ExpressRoutePort
          • index: number
          • array: ExpressRoutePort[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ExpressRoutePort, index: number, array: ExpressRoutePort[]): any
        • Parameters

          • value: ExpressRoutePort
          • index: number
          • array: ExpressRoutePort[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ExpressRoutePort[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ExpressRoutePort | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ExpressRoutePort

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ExpressRoutePort, index: number, obj: ExpressRoutePort[]): boolean
        • Parameters

          • this: void
          • value: ExpressRoutePort
          • index: number
          • obj: ExpressRoutePort[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ExpressRoutePort, index: number, obj: ExpressRoutePort[]): boolean
        • Parameters

          • value: ExpressRoutePort
          • index: number
          • obj: ExpressRoutePort[]

          Returns boolean

    • Optional thisArg: any

    Returns ExpressRoutePort | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ExpressRoutePort, index: number, obj: ExpressRoutePort[]): boolean
        • Parameters

          • value: ExpressRoutePort
          • index: number
          • obj: ExpressRoutePort[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ExpressRoutePort, index: number, array: ExpressRoutePort[]): void
        • Parameters

          • value: ExpressRoutePort
          • index: number
          • array: ExpressRoutePort[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ExpressRoutePort, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ExpressRoutePort

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ExpressRoutePort, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ExpressRoutePort

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ExpressRoutePort, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ExpressRoutePort

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ExpressRoutePort, index: number, array: ExpressRoutePort[]): U
        • Parameters

          • value: ExpressRoutePort
          • index: number
          • array: ExpressRoutePort[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ExpressRoutePort | undefined
  • Removes the last element from an array and returns it.

    Returns ExpressRoutePort | undefined

push

  • push(...items: ExpressRoutePort[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ExpressRoutePort[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ExpressRoutePort
  • reduce(callbackfn: function, initialValue: ExpressRoutePort): ExpressRoutePort
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ExpressRoutePort, currentValue: ExpressRoutePort, currentIndex: number, array: ExpressRoutePort[]): ExpressRoutePort
        • Parameters

          • previousValue: ExpressRoutePort
          • currentValue: ExpressRoutePort
          • currentIndex: number
          • array: ExpressRoutePort[]

          Returns ExpressRoutePort

    Returns ExpressRoutePort

  • Parameters

    • callbackfn: function
        • (previousValue: ExpressRoutePort, currentValue: ExpressRoutePort, currentIndex: number, array: ExpressRoutePort[]): ExpressRoutePort
        • Parameters

          • previousValue: ExpressRoutePort
          • currentValue: ExpressRoutePort
          • currentIndex: number
          • array: ExpressRoutePort[]

          Returns ExpressRoutePort

    • initialValue: ExpressRoutePort

    Returns ExpressRoutePort

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ExpressRoutePort, currentIndex: number, array: ExpressRoutePort[]): U
        • Parameters

          • previousValue: U
          • currentValue: ExpressRoutePort
          • currentIndex: number
          • array: ExpressRoutePort[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ExpressRoutePort
  • reduceRight(callbackfn: function, initialValue: ExpressRoutePort): ExpressRoutePort
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ExpressRoutePort, currentValue: ExpressRoutePort, currentIndex: number, array: ExpressRoutePort[]): ExpressRoutePort
        • Parameters

          • previousValue: ExpressRoutePort
          • currentValue: ExpressRoutePort
          • currentIndex: number
          • array: ExpressRoutePort[]

          Returns ExpressRoutePort

    Returns ExpressRoutePort

  • Parameters

    • callbackfn: function
        • (previousValue: ExpressRoutePort, currentValue: ExpressRoutePort, currentIndex: number, array: ExpressRoutePort[]): ExpressRoutePort
        • Parameters

          • previousValue: ExpressRoutePort
          • currentValue: ExpressRoutePort
          • currentIndex: number
          • array: ExpressRoutePort[]

          Returns ExpressRoutePort

    • initialValue: ExpressRoutePort

    Returns ExpressRoutePort

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ExpressRoutePort, currentIndex: number, array: ExpressRoutePort[]): U
        • Parameters

          • previousValue: U
          • currentValue: ExpressRoutePort
          • currentIndex: number
          • array: ExpressRoutePort[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ExpressRoutePort[]
  • Reverses the elements in an Array.

    Returns ExpressRoutePort[]

shift

  • shift(): ExpressRoutePort | undefined
  • Removes the first element from an array and returns it.

    Returns ExpressRoutePort | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ExpressRoutePort[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ExpressRoutePort[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ExpressRoutePort, index: number, array: ExpressRoutePort[]): boolean
        • Parameters

          • value: ExpressRoutePort
          • index: number
          • array: ExpressRoutePort[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ExpressRoutePort[]
  • splice(start: number, deleteCount: number, ...items: ExpressRoutePort[]): ExpressRoutePort[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ExpressRoutePort[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ExpressRoutePort[]

      Elements to insert into the array in place of the deleted elements.

    Returns ExpressRoutePort[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ExpressRoutePort[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ExpressRoutePort[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ExpressRoutePort>
  • Returns an iterable of values in the array

    Returns IterableIterator<ExpressRoutePort>

type

type: object

className

className: string = "ExpressRoutePortListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ExpressRoutePort"

name

name: "Composite" = "Composite"

Const ExpressRoutePortsLocation

ExpressRoutePortsLocation: object

Definition of the ExpressRoutePorts peering location resource.

summary

ExpressRoutePorts Peering Location

Optional address

address: undefined | string

Address of peering location. NOTE: This property will not be serialized. It can only be populated by the server.

Optional availableBandwidths

availableBandwidths: ExpressRoutePortsLocationBandwidths[]

The inventory of available ExpressRoutePort bandwidths.

Optional contact

contact: undefined | string

Contact details of peering locations. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the ExpressRoutePortLocation resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ExpressRoutePortsLocation"

Optional tags

tags: undefined | object

Resource tags.

type

type: object

className

className: string = "ExpressRoutePortsLocation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

address

address: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.address"

type

type: object

name

name: "String" = "String"

availableBandwidths

availableBandwidths: object

serializedName

serializedName: string = "properties.availableBandwidths"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ExpressRoutePortsLocationBandwidths"

name

name: "Composite" = "Composite"

contact

contact: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.contact"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

Const ExpressRoutePortsLocationBandwidths

ExpressRoutePortsLocationBandwidths: object

Real-time inventory of available ExpressRoute port bandwidths.

summary

ExpressRoutePorts Location Bandwidths

Optional offerName

offerName: undefined | string

Bandwidth descriptive name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ExpressRoutePortsLocationBandwidths"

Optional valueInGbps

valueInGbps: undefined | number

Bandwidth value in Gbps. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "ExpressRoutePortsLocationBandwidths"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

offerName

offerName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "offerName"

type

type: object

name

name: "String" = "String"

valueInGbps

valueInGbps: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "valueInGbps"

type

type: object

name

name: "Number" = "Number"

Const ExpressRoutePortsLocationListResult

ExpressRoutePortsLocationListResult: object
interface

Response for ListExpressRoutePortsLocations API service call.

summary

ExpressRoutePorts Location List Result

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "ExpressRoutePortsLocationListResult"

__@iterator

  • __@iterator(): IterableIterator<ExpressRoutePortsLocation>
  • Iterator

    Returns IterableIterator<ExpressRoutePortsLocation>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ExpressRoutePortsLocation>[]): ExpressRoutePortsLocation[]
  • concat(...items: (T | ConcatArray<T>)[]): ExpressRoutePortsLocation[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ExpressRoutePortsLocation>[]

      Additional items to add to the end of array1.

    Returns ExpressRoutePortsLocation[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ExpressRoutePortsLocation[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ExpressRoutePortsLocation]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ExpressRoutePortsLocation]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ExpressRoutePortsLocation, index: number, array: ExpressRoutePortsLocation[]): boolean
        • Parameters

          • value: ExpressRoutePortsLocation
          • index: number
          • array: ExpressRoutePortsLocation[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ExpressRoutePortsLocation, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ExpressRoutePortsLocation

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ExpressRoutePortsLocation[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ExpressRoutePortsLocation

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ExpressRoutePortsLocation, index: number, array: ExpressRoutePortsLocation[]): boolean
        • Parameters

          • value: ExpressRoutePortsLocation
          • index: number
          • array: ExpressRoutePortsLocation[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ExpressRoutePortsLocation, index: number, array: ExpressRoutePortsLocation[]): any
        • Parameters

          • value: ExpressRoutePortsLocation
          • index: number
          • array: ExpressRoutePortsLocation[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ExpressRoutePortsLocation[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ExpressRoutePortsLocation | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ExpressRoutePortsLocation

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ExpressRoutePortsLocation, index: number, obj: ExpressRoutePortsLocation[]): boolean
        • Parameters

          • this: void
          • value: ExpressRoutePortsLocation
          • index: number
          • obj: ExpressRoutePortsLocation[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ExpressRoutePortsLocation, index: number, obj: ExpressRoutePortsLocation[]): boolean
        • Parameters

          • value: ExpressRoutePortsLocation
          • index: number
          • obj: ExpressRoutePortsLocation[]

          Returns boolean

    • Optional thisArg: any

    Returns ExpressRoutePortsLocation | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ExpressRoutePortsLocation, index: number, obj: ExpressRoutePortsLocation[]): boolean
        • Parameters

          • value: ExpressRoutePortsLocation
          • index: number
          • obj: ExpressRoutePortsLocation[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ExpressRoutePortsLocation, index: number, array: ExpressRoutePortsLocation[]): void
        • Parameters

          • value: ExpressRoutePortsLocation
          • index: number
          • array: ExpressRoutePortsLocation[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ExpressRoutePortsLocation, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ExpressRoutePortsLocation

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ExpressRoutePortsLocation, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ExpressRoutePortsLocation

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ExpressRoutePortsLocation, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ExpressRoutePortsLocation

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ExpressRoutePortsLocation, index: number, array: ExpressRoutePortsLocation[]): U
        • Parameters

          • value: ExpressRoutePortsLocation
          • index: number
          • array: ExpressRoutePortsLocation[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ExpressRoutePortsLocation | undefined
  • Removes the last element from an array and returns it.

    Returns ExpressRoutePortsLocation | undefined

push

  • push(...items: ExpressRoutePortsLocation[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ExpressRoutePortsLocation[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ExpressRoutePortsLocation
  • reduce(callbackfn: function, initialValue: ExpressRoutePortsLocation): ExpressRoutePortsLocation
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ExpressRoutePortsLocation, currentValue: ExpressRoutePortsLocation, currentIndex: number, array: ExpressRoutePortsLocation[]): ExpressRoutePortsLocation
        • Parameters

          • previousValue: ExpressRoutePortsLocation
          • currentValue: ExpressRoutePortsLocation
          • currentIndex: number
          • array: ExpressRoutePortsLocation[]

          Returns ExpressRoutePortsLocation

    Returns ExpressRoutePortsLocation

  • Parameters

    • callbackfn: function
        • (previousValue: ExpressRoutePortsLocation, currentValue: ExpressRoutePortsLocation, currentIndex: number, array: ExpressRoutePortsLocation[]): ExpressRoutePortsLocation
        • Parameters

          • previousValue: ExpressRoutePortsLocation
          • currentValue: ExpressRoutePortsLocation
          • currentIndex: number
          • array: ExpressRoutePortsLocation[]

          Returns ExpressRoutePortsLocation

    • initialValue: ExpressRoutePortsLocation

    Returns ExpressRoutePortsLocation

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ExpressRoutePortsLocation, currentIndex: number, array: ExpressRoutePortsLocation[]): U
        • Parameters

          • previousValue: U
          • currentValue: ExpressRoutePortsLocation
          • currentIndex: number
          • array: ExpressRoutePortsLocation[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ExpressRoutePortsLocation
  • reduceRight(callbackfn: function, initialValue: ExpressRoutePortsLocation): ExpressRoutePortsLocation
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ExpressRoutePortsLocation, currentValue: ExpressRoutePortsLocation, currentIndex: number, array: ExpressRoutePortsLocation[]): ExpressRoutePortsLocation
        • Parameters

          • previousValue: ExpressRoutePortsLocation
          • currentValue: ExpressRoutePortsLocation
          • currentIndex: number
          • array: ExpressRoutePortsLocation[]

          Returns ExpressRoutePortsLocation

    Returns ExpressRoutePortsLocation

  • Parameters

    • callbackfn: function
        • (previousValue: ExpressRoutePortsLocation, currentValue: ExpressRoutePortsLocation, currentIndex: number, array: ExpressRoutePortsLocation[]): ExpressRoutePortsLocation
        • Parameters

          • previousValue: ExpressRoutePortsLocation
          • currentValue: ExpressRoutePortsLocation
          • currentIndex: number
          • array: ExpressRoutePortsLocation[]

          Returns ExpressRoutePortsLocation

    • initialValue: ExpressRoutePortsLocation

    Returns ExpressRoutePortsLocation

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ExpressRoutePortsLocation, currentIndex: number, array: ExpressRoutePortsLocation[]): U
        • Parameters

          • previousValue: U
          • currentValue: ExpressRoutePortsLocation
          • currentIndex: number
          • array: ExpressRoutePortsLocation[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ExpressRoutePortsLocation[]
  • Reverses the elements in an Array.

    Returns ExpressRoutePortsLocation[]

shift

  • shift(): ExpressRoutePortsLocation | undefined
  • Removes the first element from an array and returns it.

    Returns ExpressRoutePortsLocation | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ExpressRoutePortsLocation[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ExpressRoutePortsLocation[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ExpressRoutePortsLocation, index: number, array: ExpressRoutePortsLocation[]): boolean
        • Parameters

          • value: ExpressRoutePortsLocation
          • index: number
          • array: ExpressRoutePortsLocation[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ExpressRoutePortsLocation[]
  • splice(start: number, deleteCount: number, ...items: ExpressRoutePortsLocation[]): ExpressRoutePortsLocation[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ExpressRoutePortsLocation[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ExpressRoutePortsLocation[]

      Elements to insert into the array in place of the deleted elements.

    Returns ExpressRoutePortsLocation[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ExpressRoutePortsLocation[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ExpressRoutePortsLocation[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ExpressRoutePortsLocation>
  • Returns an iterable of values in the array

    Returns IterableIterator<ExpressRoutePortsLocation>

type

type: object

className

className: string = "ExpressRoutePortsLocationListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ExpressRoutePortsLocation"

name

name: "Composite" = "Composite"

Const ExpressRouteServiceProvider

ExpressRouteServiceProvider: object

A ExpressRouteResourceProvider object.

Optional bandwidthsOffered

bandwidthsOffered: ExpressRouteServiceProviderBandwidthsOffered[]

Gets bandwidths offered.

Optional id

id: undefined | string

Resource ID.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional peeringLocations

peeringLocations: string[]

Get a list of peering locations.

Optional provisioningState

provisioningState: undefined | string

Gets the provisioning state of the resource.

serializedName

serializedName: string = "ExpressRouteServiceProvider"

Optional tags

tags: undefined | object

Resource tags.

type

type: object

className

className: string = "ExpressRouteServiceProvider"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

bandwidthsOffered

bandwidthsOffered: object

serializedName

serializedName: string = "properties.bandwidthsOffered"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ExpressRouteServiceProviderBandwidthsOffered"

name

name: "Composite" = "Composite"

peeringLocations

peeringLocations: object

serializedName

serializedName: string = "properties.peeringLocations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

Const ExpressRouteServiceProviderBandwidthsOffered

ExpressRouteServiceProviderBandwidthsOffered: object

Contains bandwidths offered in ExpressRouteServiceProvider resources.

Optional offerName

offerName: undefined | string

The OfferName.

serializedName

serializedName: string = "ExpressRouteServiceProviderBandwidthsOffered"

Optional valueInMbps

valueInMbps: undefined | number

The ValueInMbps.

type

type: object

className

className: string = "ExpressRouteServiceProviderBandwidthsOffered"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

offerName

offerName: object

serializedName

serializedName: string = "offerName"

type

type: object

name

name: "String" = "String"

valueInMbps

valueInMbps: object

serializedName

serializedName: string = "valueInMbps"

type

type: object

name

name: "Number" = "Number"

Const ExpressRouteServiceProviderListResult

ExpressRouteServiceProviderListResult: object
interface

Response for the ListExpressRouteServiceProvider API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "ExpressRouteServiceProviderListResult"

__@iterator

  • __@iterator(): IterableIterator<ExpressRouteServiceProvider>
  • Iterator

    Returns IterableIterator<ExpressRouteServiceProvider>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ExpressRouteServiceProvider>[]): ExpressRouteServiceProvider[]
  • concat(...items: (T | ConcatArray<T>)[]): ExpressRouteServiceProvider[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ExpressRouteServiceProvider>[]

      Additional items to add to the end of array1.

    Returns ExpressRouteServiceProvider[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ExpressRouteServiceProvider[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ExpressRouteServiceProvider]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ExpressRouteServiceProvider]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ExpressRouteServiceProvider, index: number, array: ExpressRouteServiceProvider[]): boolean
        • Parameters

          • value: ExpressRouteServiceProvider
          • index: number
          • array: ExpressRouteServiceProvider[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ExpressRouteServiceProvider, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ExpressRouteServiceProvider

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ExpressRouteServiceProvider[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ExpressRouteServiceProvider

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ExpressRouteServiceProvider, index: number, array: ExpressRouteServiceProvider[]): boolean
        • Parameters

          • value: ExpressRouteServiceProvider
          • index: number
          • array: ExpressRouteServiceProvider[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ExpressRouteServiceProvider, index: number, array: ExpressRouteServiceProvider[]): any
        • Parameters

          • value: ExpressRouteServiceProvider
          • index: number
          • array: ExpressRouteServiceProvider[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ExpressRouteServiceProvider[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ExpressRouteServiceProvider | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ExpressRouteServiceProvider

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ExpressRouteServiceProvider, index: number, obj: ExpressRouteServiceProvider[]): boolean
        • Parameters

          • this: void
          • value: ExpressRouteServiceProvider
          • index: number
          • obj: ExpressRouteServiceProvider[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ExpressRouteServiceProvider, index: number, obj: ExpressRouteServiceProvider[]): boolean
        • Parameters

          • value: ExpressRouteServiceProvider
          • index: number
          • obj: ExpressRouteServiceProvider[]

          Returns boolean

    • Optional thisArg: any

    Returns ExpressRouteServiceProvider | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ExpressRouteServiceProvider, index: number, obj: ExpressRouteServiceProvider[]): boolean
        • Parameters

          • value: ExpressRouteServiceProvider
          • index: number
          • obj: ExpressRouteServiceProvider[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ExpressRouteServiceProvider, index: number, array: ExpressRouteServiceProvider[]): void
        • Parameters

          • value: ExpressRouteServiceProvider
          • index: number
          • array: ExpressRouteServiceProvider[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ExpressRouteServiceProvider, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ExpressRouteServiceProvider

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ExpressRouteServiceProvider, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ExpressRouteServiceProvider

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ExpressRouteServiceProvider, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ExpressRouteServiceProvider

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ExpressRouteServiceProvider, index: number, array: ExpressRouteServiceProvider[]): U
        • Parameters

          • value: ExpressRouteServiceProvider
          • index: number
          • array: ExpressRouteServiceProvider[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ExpressRouteServiceProvider | undefined
  • Removes the last element from an array and returns it.

    Returns ExpressRouteServiceProvider | undefined

push

  • push(...items: ExpressRouteServiceProvider[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ExpressRouteServiceProvider[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ExpressRouteServiceProvider
  • reduce(callbackfn: function, initialValue: ExpressRouteServiceProvider): ExpressRouteServiceProvider
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ExpressRouteServiceProvider, currentValue: ExpressRouteServiceProvider, currentIndex: number, array: ExpressRouteServiceProvider[]): ExpressRouteServiceProvider
        • Parameters

          • previousValue: ExpressRouteServiceProvider
          • currentValue: ExpressRouteServiceProvider
          • currentIndex: number
          • array: ExpressRouteServiceProvider[]

          Returns ExpressRouteServiceProvider

    Returns ExpressRouteServiceProvider

  • Parameters

    • callbackfn: function
        • (previousValue: ExpressRouteServiceProvider, currentValue: ExpressRouteServiceProvider, currentIndex: number, array: ExpressRouteServiceProvider[]): ExpressRouteServiceProvider
        • Parameters

          • previousValue: ExpressRouteServiceProvider
          • currentValue: ExpressRouteServiceProvider
          • currentIndex: number
          • array: ExpressRouteServiceProvider[]

          Returns ExpressRouteServiceProvider

    • initialValue: ExpressRouteServiceProvider

    Returns ExpressRouteServiceProvider

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ExpressRouteServiceProvider, currentIndex: number, array: ExpressRouteServiceProvider[]): U
        • Parameters

          • previousValue: U
          • currentValue: ExpressRouteServiceProvider
          • currentIndex: number
          • array: ExpressRouteServiceProvider[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ExpressRouteServiceProvider
  • reduceRight(callbackfn: function, initialValue: ExpressRouteServiceProvider): ExpressRouteServiceProvider
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ExpressRouteServiceProvider, currentValue: ExpressRouteServiceProvider, currentIndex: number, array: ExpressRouteServiceProvider[]): ExpressRouteServiceProvider
        • Parameters

          • previousValue: ExpressRouteServiceProvider
          • currentValue: ExpressRouteServiceProvider
          • currentIndex: number
          • array: ExpressRouteServiceProvider[]

          Returns ExpressRouteServiceProvider

    Returns ExpressRouteServiceProvider

  • Parameters

    • callbackfn: function
        • (previousValue: ExpressRouteServiceProvider, currentValue: ExpressRouteServiceProvider, currentIndex: number, array: ExpressRouteServiceProvider[]): ExpressRouteServiceProvider
        • Parameters

          • previousValue: ExpressRouteServiceProvider
          • currentValue: ExpressRouteServiceProvider
          • currentIndex: number
          • array: ExpressRouteServiceProvider[]

          Returns ExpressRouteServiceProvider

    • initialValue: ExpressRouteServiceProvider

    Returns ExpressRouteServiceProvider

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ExpressRouteServiceProvider, currentIndex: number, array: ExpressRouteServiceProvider[]): U
        • Parameters

          • previousValue: U
          • currentValue: ExpressRouteServiceProvider
          • currentIndex: number
          • array: ExpressRouteServiceProvider[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ExpressRouteServiceProvider[]
  • Reverses the elements in an Array.

    Returns ExpressRouteServiceProvider[]

shift

  • shift(): ExpressRouteServiceProvider | undefined
  • Removes the first element from an array and returns it.

    Returns ExpressRouteServiceProvider | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ExpressRouteServiceProvider[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ExpressRouteServiceProvider[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ExpressRouteServiceProvider, index: number, array: ExpressRouteServiceProvider[]): boolean
        • Parameters

          • value: ExpressRouteServiceProvider
          • index: number
          • array: ExpressRouteServiceProvider[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ExpressRouteServiceProvider[]
  • splice(start: number, deleteCount: number, ...items: ExpressRouteServiceProvider[]): ExpressRouteServiceProvider[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ExpressRouteServiceProvider[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ExpressRouteServiceProvider[]

      Elements to insert into the array in place of the deleted elements.

    Returns ExpressRouteServiceProvider[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ExpressRouteServiceProvider[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ExpressRouteServiceProvider[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ExpressRouteServiceProvider>
  • Returns an iterable of values in the array

    Returns IterableIterator<ExpressRouteServiceProvider>

type

type: object

className

className: string = "ExpressRouteServiceProviderListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ExpressRouteServiceProvider"

name

name: "Composite" = "Composite"

Const FlowLogFormatParameters

FlowLogFormatParameters: object

Parameters that define the flow log format.

serializedName

serializedName: string = "FlowLogFormatParameters"

Optional version

version: undefined | number

The version (revision) of the flow log. Default value: 0.

type

type: object

The file type of flow log. Possible values include: 'JSON'

className

className: string = "FlowLogFormatParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

version

version: object

defaultValue

defaultValue: number = 0

serializedName

serializedName: string = "version"

type

type: object

name

name: "Number" = "Number"

Const FlowLogInformation

FlowLogInformation: object

Information on the configuration of flow log and traffic analytics (optional) .

enabled

enabled: boolean

Flag to enable/disable flow logging.

Optional flowAnalyticsConfiguration

flowAnalyticsConfiguration: TrafficAnalyticsProperties

Parameters that define the configuration of traffic analytics.

Optional format

Parameters that define the flow log format.

Optional retentionPolicy

retentionPolicy: RetentionPolicyParameters

Parameters that define the retention policy for flow log.

serializedName

serializedName: string = "FlowLogInformation"

storageId

storageId: string

ID of the storage account which is used to store the flow log.

targetResourceId

targetResourceId: string

The ID of the resource to configure for flow log and traffic analytics (optional) .

type

type: object

className

className: string = "FlowLogInformation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

enabled

enabled: object

required

required: true = true

serializedName

serializedName: string = "properties.enabled"

type

type: object

name

name: "Boolean" = "Boolean"

flowAnalyticsConfiguration

flowAnalyticsConfiguration: object

serializedName

serializedName: string = "flowAnalyticsConfiguration"

type

type: object

className

className: string = "TrafficAnalyticsProperties"

name

name: "Composite" = "Composite"

format

format: object

serializedName

serializedName: string = "properties.format"

type

type: object

className

className: string = "FlowLogFormatParameters"

name

name: "Composite" = "Composite"

retentionPolicy

retentionPolicy: object

serializedName

serializedName: string = "properties.retentionPolicy"

type

type: object

className

className: string = "RetentionPolicyParameters"

name

name: "Composite" = "Composite"

storageId

storageId: object

required

required: true = true

serializedName

serializedName: string = "properties.storageId"

type

type: object

name

name: "String" = "String"

targetResourceId

targetResourceId: object

required

required: true = true

serializedName

serializedName: string = "targetResourceId"

type

type: object

name

name: "String" = "String"

Const FlowLogStatusParameters

FlowLogStatusParameters: object

Parameters that define a resource to query flow log and traffic analytics (optional) status.

serializedName

serializedName: string = "FlowLogStatusParameters"

targetResourceId

targetResourceId: string

The target resource where getting the flow log and traffic analytics (optional) status.

type

type: object

className

className: string = "FlowLogStatusParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

targetResourceId

targetResourceId: object

required

required: true = true

serializedName

serializedName: string = "targetResourceId"

type

type: object

name

name: "String" = "String"

Const FrontendIPConfiguration

FrontendIPConfiguration: object

Frontend IP address of the load balancer.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional inboundNatPools

inboundNatPools: SubResource[]

Read only. Inbound pools URIs that use this frontend IP. NOTE: This property will not be serialized. It can only be populated by the server.

Optional inboundNatRules

inboundNatRules: SubResource[]

Read only. Inbound rules URIs that use this frontend IP. NOTE: This property will not be serialized. It can only be populated by the server.

Optional loadBalancingRules

loadBalancingRules: SubResource[]

Gets load balancing rules URIs that use this frontend IP. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional outboundRules

outboundRules: SubResource[]

Read only. Outbound rules URIs that use this frontend IP. NOTE: This property will not be serialized. It can only be populated by the server.

Optional privateIPAddress

privateIPAddress: undefined | string

The private IP address of the IP configuration.

Optional privateIPAllocationMethod

privateIPAllocationMethod: IPAllocationMethod

The Private IP allocation method. Possible values include: 'Static', 'Dynamic'

Optional provisioningState

provisioningState: undefined | string

Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

Optional publicIPAddress

publicIPAddress: PublicIPAddress

The reference of the Public IP resource.

Optional publicIPPrefix

publicIPPrefix: SubResource

The reference of the Public IP Prefix resource.

serializedName

serializedName: string = "FrontendIPConfiguration"

Optional subnet

subnet: Subnet

The reference of the subnet resource.

Optional zones

zones: string[]

A list of availability zones denoting the IP allocated for the resource needs to come from.

type

type: object

className

className: string = "FrontendIPConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

inboundNatPools

inboundNatPools: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.inboundNatPools"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

inboundNatRules

inboundNatRules: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.inboundNatRules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

loadBalancingRules

loadBalancingRules: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.loadBalancingRules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

outboundRules

outboundRules: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.outboundRules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

privateIPAddress

privateIPAddress: object

serializedName

serializedName: string = "properties.privateIPAddress"

type

type: object

name

name: "String" = "String"

privateIPAllocationMethod

privateIPAllocationMethod: object

serializedName

serializedName: string = "properties.privateIPAllocationMethod"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

publicIPAddress

publicIPAddress: object

serializedName

serializedName: string = "properties.publicIPAddress"

type

type: object

className

className: string = "PublicIPAddress"

name

name: "Composite" = "Composite"

publicIPPrefix

publicIPPrefix: object

serializedName

serializedName: string = "properties.publicIPPrefix"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

subnet

subnet: object

serializedName

serializedName: string = "properties.subnet"

type

type: object

className

className: string = "Subnet"

name

name: "Composite" = "Composite"

zones

zones: object

serializedName

serializedName: string = "zones"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const GatewayRoute

GatewayRoute: object

Gateway routing details.

Optional asPath

asPath: undefined | string

The route's AS path sequence. NOTE: This property will not be serialized. It can only be populated by the server.

Optional localAddress

localAddress: undefined | string

The gateway's local address. NOTE: This property will not be serialized. It can only be populated by the server.

Optional network

network: undefined | string

The route's network prefix. NOTE: This property will not be serialized. It can only be populated by the server.

Optional nextHop

nextHop: undefined | string

The route's next hop. NOTE: This property will not be serialized. It can only be populated by the server.

Optional origin

origin: undefined | string

The source this route was learned from. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "GatewayRoute"

Optional sourcePeer

sourcePeer: undefined | string

The peer this route was learned from. NOTE: This property will not be serialized. It can only be populated by the server.

Optional weight

weight: undefined | number

The route's weight. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "GatewayRoute"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

asPath

asPath: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "asPath"

type

type: object

name

name: "String" = "String"

localAddress

localAddress: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "localAddress"

type

type: object

name

name: "String" = "String"

network

network: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "network"

type

type: object

name

name: "String" = "String"

nextHop

nextHop: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextHop"

type

type: object

name

name: "String" = "String"

origin

origin: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "origin"

type

type: object

name

name: "String" = "String"

sourcePeer

sourcePeer: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "sourcePeer"

type

type: object

name

name: "String" = "String"

weight

weight: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "weight"

type

type: object

name

name: "Number" = "Number"

Const GatewayRouteListResult

GatewayRouteListResult: object

List of virtual network gateway routes.

serializedName

serializedName: string = "GatewayRouteListResult"

Optional value

value: GatewayRoute[]

List of gateway routes.

type

type: object

className

className: string = "GatewayRouteListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "GatewayRoute"

name

name: "Composite" = "Composite"

Const GetVpnSitesConfigurationRequest

GetVpnSitesConfigurationRequest: object

List of Vpn-Sites.

outputBlobSasUrl

outputBlobSasUrl: string

The sas-url to download the configurations for vpn-sites.

serializedName

serializedName: string = "GetVpnSitesConfigurationRequest"

Optional vpnSites

vpnSites: string[]

List of resource-ids of the vpn-sites for which config is to be downloaded.

type

type: object

className

className: string = "GetVpnSitesConfigurationRequest"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

outputBlobSasUrl

outputBlobSasUrl: object

required

required: true = true

serializedName

serializedName: string = "outputBlobSasUrl"

type

type: object

name

name: "String" = "String"

vpnSites

vpnSites: object

serializedName

serializedName: string = "vpnSites"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const HTTPConfiguration

HTTPConfiguration: object

HTTP configuration of the connectivity check.

Optional headers

headers: HTTPHeader[]

List of HTTP headers.

Optional method

method: HTTPMethod

HTTP method. Possible values include: 'Get'

serializedName

serializedName: string = "HTTPConfiguration"

Optional validStatusCodes

validStatusCodes: number[]

Valid status codes.

type

type: object

className

className: string = "HTTPConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

headers

headers: object

serializedName

serializedName: string = "headers"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HTTPHeader"

name

name: "Composite" = "Composite"

method

method: object

serializedName

serializedName: string = "method"

type

type: object

name

name: "String" = "String"

validStatusCodes

validStatusCodes: object

serializedName

serializedName: string = "validStatusCodes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "Number" = "Number"

Const HTTPHeader

HTTPHeader: object

Describes the HTTP header.

Optional name

name: undefined | string

The name in HTTP header.

serializedName

serializedName: string = "HTTPHeader"

Optional value

value: undefined | string

The value in HTTP header.

type

type: object

className

className: string = "HTTPHeader"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const HubVirtualNetworkConnection

HubVirtualNetworkConnection: object

HubVirtualNetworkConnection Resource.

Optional allowHubToRemoteVnetTransit

allowHubToRemoteVnetTransit: undefined | false | true

VirtualHub to RemoteVnet transit to enabled or not.

Optional allowRemoteVnetToUseHubVnetGateways

allowRemoteVnetToUseHubVnetGateways: undefined | false | true

Allow RemoteVnet to use Virtual Hub's gateways.

Optional enableInternetSecurity

enableInternetSecurity: undefined | false | true

Enable internet security.

Optional etag

etag: undefined | string

Gets a unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional provisioningState

provisioningState: ProvisioningState

The provisioning state of the resource. Possible values include: 'Succeeded', 'Updating', 'Deleting', 'Failed'

Optional remoteVirtualNetwork

remoteVirtualNetwork: SubResource

Reference to the remote virtual network.

serializedName

serializedName: string = "HubVirtualNetworkConnection"

type

type: object

className

className: string = "HubVirtualNetworkConnection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

allowHubToRemoteVnetTransit

allowHubToRemoteVnetTransit: object

serializedName

serializedName: string = "properties.allowHubToRemoteVnetTransit"

type

type: object

name

name: "Boolean" = "Boolean"

allowRemoteVnetToUseHubVnetGateways

allowRemoteVnetToUseHubVnetGateways: object

serializedName

serializedName: string = "properties.allowRemoteVnetToUseHubVnetGateways"

type

type: object

name

name: "Boolean" = "Boolean"

enableInternetSecurity

enableInternetSecurity: object

serializedName

serializedName: string = "properties.enableInternetSecurity"

type

type: object

name

name: "Boolean" = "Boolean"

etag

etag: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

remoteVirtualNetwork

remoteVirtualNetwork: object

serializedName

serializedName: string = "properties.remoteVirtualNetwork"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

Const IPAddressAvailabilityResult

IPAddressAvailabilityResult: object

Response for CheckIPAddressAvailability API service call.

Optional available

available: undefined | false | true

Private IP address availability.

Optional availableIPAddresses

availableIPAddresses: string[]

Contains other available private IP addresses if the asked for address is taken.

serializedName

serializedName: string = "IPAddressAvailabilityResult"

type

type: object

className

className: string = "IPAddressAvailabilityResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

available

available: object

serializedName

serializedName: string = "available"

type

type: object

name

name: "Boolean" = "Boolean"

availableIPAddresses

availableIPAddresses: object

serializedName

serializedName: string = "availableIPAddresses"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const IPConfiguration

IPConfiguration: object

IP configuration.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional privateIPAddress

privateIPAddress: undefined | string

The private IP address of the IP configuration.

Optional privateIPAllocationMethod

privateIPAllocationMethod: IPAllocationMethod

The private IP address allocation method. Possible values include: 'Static', 'Dynamic'

Optional provisioningState

provisioningState: undefined | string

Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

Optional publicIPAddress

publicIPAddress: PublicIPAddress

The reference of the public IP resource.

serializedName

serializedName: string = "IPConfiguration"

Optional subnet

subnet: Subnet

The reference of the subnet resource.

type

type: object

className

className: string = "IPConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

privateIPAddress

privateIPAddress: object

serializedName

serializedName: string = "properties.privateIPAddress"

type

type: object

name

name: "String" = "String"

privateIPAllocationMethod

privateIPAllocationMethod: object

serializedName

serializedName: string = "properties.privateIPAllocationMethod"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

publicIPAddress

publicIPAddress: object

serializedName

serializedName: string = "properties.publicIPAddress"

type

type: object

className

className: string = "PublicIPAddress"

name

name: "Composite" = "Composite"

subnet

subnet: object

serializedName

serializedName: string = "properties.subnet"

type

type: object

className

className: string = "Subnet"

name

name: "Composite" = "Composite"

Const IPConfigurationProfile

IPConfigurationProfile: object

IP configuration profile child resource.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

The name of the resource. This name can be used to access the resource.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "IPConfigurationProfile"

Optional subnet

subnet: Subnet

The reference of the subnet resource to create a container network interface ip configuration.

type

type: object

Sub Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "IPConfigurationProfile"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

subnet

subnet: object

serializedName

serializedName: string = "properties.subnet"

type

type: object

className

className: string = "Subnet"

name

name: "Composite" = "Composite"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const InboundNatPool

InboundNatPool: object

Inbound NAT pool of the load balancer.

backendPort

backendPort: number

The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.

Optional enableFloatingIP

enableFloatingIP: undefined | false | true

Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.

Optional enableTcpReset

enableTcpReset: undefined | false | true

Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional frontendIPConfiguration

frontendIPConfiguration: SubResource

A reference to frontend IP addresses.

frontendPortRangeEnd

frontendPortRangeEnd: number

The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65535.

frontendPortRangeStart

frontendPortRangeStart: number

The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65534.

Optional id

id: undefined | string

Resource ID.

Optional idleTimeoutInMinutes

idleTimeoutInMinutes: undefined | number

The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.

Optional name

name: undefined | string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

protocol

The reference to the transport protocol used by the inbound NAT pool. Possible values include: 'Udp', 'Tcp', 'All'

Optional provisioningState

provisioningState: undefined | string

Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

serializedName

serializedName: string = "InboundNatPool"

type

type: object

className

className: string = "InboundNatPool"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backendPort

backendPort: object

required

required: true = true

serializedName

serializedName: string = "properties.backendPort"

type

type: object

name

name: "Number" = "Number"

enableFloatingIP

enableFloatingIP: object

serializedName

serializedName: string = "properties.enableFloatingIP"

type

type: object

name

name: "Boolean" = "Boolean"

enableTcpReset

enableTcpReset: object

serializedName

serializedName: string = "properties.enableTcpReset"

type

type: object

name

name: "Boolean" = "Boolean"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

frontendIPConfiguration

frontendIPConfiguration: object

serializedName

serializedName: string = "properties.frontendIPConfiguration"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

frontendPortRangeEnd

frontendPortRangeEnd: object

required

required: true = true

serializedName

serializedName: string = "properties.frontendPortRangeEnd"

type

type: object

name

name: "Number" = "Number"

frontendPortRangeStart

frontendPortRangeStart: object

required

required: true = true

serializedName

serializedName: string = "properties.frontendPortRangeStart"

type

type: object

name

name: "Number" = "Number"

idleTimeoutInMinutes

idleTimeoutInMinutes: object

serializedName

serializedName: string = "properties.idleTimeoutInMinutes"

type

type: object

name

name: "Number" = "Number"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

protocol

protocol: object

required

required: true = true

serializedName

serializedName: string = "properties.protocol"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

Const InboundNatRule

InboundNatRule: object

Inbound NAT rule of the load balancer.

Optional backendIPConfiguration

backendIPConfiguration: NetworkInterfaceIPConfiguration

A reference to a private IP address defined on a network interface of a VM. Traffic sent to the frontend port of each of the frontend IP configurations is forwarded to the backend IP. NOTE: This property will not be serialized. It can only be populated by the server.

Optional backendPort

backendPort: undefined | number

The port used for the internal endpoint. Acceptable values range from 1 to 65535.

Optional enableFloatingIP

enableFloatingIP: undefined | false | true

Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.

Optional enableTcpReset

enableTcpReset: undefined | false | true

Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional frontendIPConfiguration

frontendIPConfiguration: SubResource

A reference to frontend IP addresses.

Optional frontendPort

frontendPort: undefined | number

The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534.

Optional id

id: undefined | string

Resource ID.

Optional idleTimeoutInMinutes

idleTimeoutInMinutes: undefined | number

The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.

Optional name

name: undefined | string

Gets name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional protocol

The reference to the transport protocol used by the load balancing rule. Possible values include: 'Udp', 'Tcp', 'All'

Optional provisioningState

provisioningState: undefined | string

Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

serializedName

serializedName: string = "InboundNatRule"

type

type: object

className

className: string = "InboundNatRule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backendIPConfiguration

backendIPConfiguration: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.backendIPConfiguration"

type

type: object

className

className: string = "NetworkInterfaceIPConfiguration"

name

name: "Composite" = "Composite"

backendPort

backendPort: object

serializedName

serializedName: string = "properties.backendPort"

type

type: object

name

name: "Number" = "Number"

enableFloatingIP

enableFloatingIP: object

serializedName

serializedName: string = "properties.enableFloatingIP"

type

type: object

name

name: "Boolean" = "Boolean"

enableTcpReset

enableTcpReset: object

serializedName

serializedName: string = "properties.enableTcpReset"

type

type: object

name

name: "Boolean" = "Boolean"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

frontendIPConfiguration

frontendIPConfiguration: object

serializedName

serializedName: string = "properties.frontendIPConfiguration"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

frontendPort

frontendPort: object

serializedName

serializedName: string = "properties.frontendPort"

type

type: object

name

name: "Number" = "Number"

idleTimeoutInMinutes

idleTimeoutInMinutes: object

serializedName

serializedName: string = "properties.idleTimeoutInMinutes"

type

type: object

name

name: "Number" = "Number"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

protocol

protocol: object

serializedName

serializedName: string = "properties.protocol"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

Const InboundNatRuleListResult

InboundNatRuleListResult: object
interface

Response for ListInboundNatRule API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "InboundNatRuleListResult"

__@iterator

  • __@iterator(): IterableIterator<InboundNatRule>
  • Iterator

    Returns IterableIterator<InboundNatRule>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<InboundNatRule>[]): InboundNatRule[]
  • concat(...items: (T | ConcatArray<T>)[]): InboundNatRule[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<InboundNatRule>[]

      Additional items to add to the end of array1.

    Returns InboundNatRule[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns InboundNatRule[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, InboundNatRule]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, InboundNatRule]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: InboundNatRule, index: number, array: InboundNatRule[]): boolean
        • Parameters

          • value: InboundNatRule
          • index: number
          • array: InboundNatRule[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: InboundNatRule, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: InboundNatRule

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): InboundNatRule[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: InboundNatRule

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: InboundNatRule, index: number, array: InboundNatRule[]): boolean
        • Parameters

          • value: InboundNatRule
          • index: number
          • array: InboundNatRule[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: InboundNatRule, index: number, array: InboundNatRule[]): any
        • Parameters

          • value: InboundNatRule
          • index: number
          • array: InboundNatRule[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns InboundNatRule[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): InboundNatRule | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: InboundNatRule

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: InboundNatRule, index: number, obj: InboundNatRule[]): boolean
        • Parameters

          • this: void
          • value: InboundNatRule
          • index: number
          • obj: InboundNatRule[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: InboundNatRule, index: number, obj: InboundNatRule[]): boolean
        • Parameters

          • value: InboundNatRule
          • index: number
          • obj: InboundNatRule[]

          Returns boolean

    • Optional thisArg: any

    Returns InboundNatRule | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: InboundNatRule, index: number, obj: InboundNatRule[]): boolean
        • Parameters

          • value: InboundNatRule
          • index: number
          • obj: InboundNatRule[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: InboundNatRule, index: number, array: InboundNatRule[]): void
        • Parameters

          • value: InboundNatRule
          • index: number
          • array: InboundNatRule[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: InboundNatRule, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: InboundNatRule

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: InboundNatRule, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: InboundNatRule

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: InboundNatRule, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: InboundNatRule

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: InboundNatRule, index: number, array: InboundNatRule[]): U
        • Parameters

          • value: InboundNatRule
          • index: number
          • array: InboundNatRule[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): InboundNatRule | undefined
  • Removes the last element from an array and returns it.

    Returns InboundNatRule | undefined

push

  • push(...items: InboundNatRule[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: InboundNatRule[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): InboundNatRule
  • reduce(callbackfn: function, initialValue: InboundNatRule): InboundNatRule
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: InboundNatRule, currentValue: InboundNatRule, currentIndex: number, array: InboundNatRule[]): InboundNatRule
        • Parameters

          • previousValue: InboundNatRule
          • currentValue: InboundNatRule
          • currentIndex: number
          • array: InboundNatRule[]

          Returns InboundNatRule

    Returns InboundNatRule

  • Parameters

    • callbackfn: function
        • (previousValue: InboundNatRule, currentValue: InboundNatRule, currentIndex: number, array: InboundNatRule[]): InboundNatRule
        • Parameters

          • previousValue: InboundNatRule
          • currentValue: InboundNatRule
          • currentIndex: number
          • array: InboundNatRule[]

          Returns InboundNatRule

    • initialValue: InboundNatRule

    Returns InboundNatRule

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: InboundNatRule, currentIndex: number, array: InboundNatRule[]): U
        • Parameters

          • previousValue: U
          • currentValue: InboundNatRule
          • currentIndex: number
          • array: InboundNatRule[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): InboundNatRule
  • reduceRight(callbackfn: function, initialValue: InboundNatRule): InboundNatRule
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: InboundNatRule, currentValue: InboundNatRule, currentIndex: number, array: InboundNatRule[]): InboundNatRule
        • Parameters

          • previousValue: InboundNatRule
          • currentValue: InboundNatRule
          • currentIndex: number
          • array: InboundNatRule[]

          Returns InboundNatRule

    Returns InboundNatRule

  • Parameters

    • callbackfn: function
        • (previousValue: InboundNatRule, currentValue: InboundNatRule, currentIndex: number, array: InboundNatRule[]): InboundNatRule
        • Parameters

          • previousValue: InboundNatRule
          • currentValue: InboundNatRule
          • currentIndex: number
          • array: InboundNatRule[]

          Returns InboundNatRule

    • initialValue: InboundNatRule

    Returns InboundNatRule

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: InboundNatRule, currentIndex: number, array: InboundNatRule[]): U
        • Parameters

          • previousValue: U
          • currentValue: InboundNatRule
          • currentIndex: number
          • array: InboundNatRule[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): InboundNatRule[]
  • Reverses the elements in an Array.

    Returns InboundNatRule[]

shift

  • shift(): InboundNatRule | undefined
  • Removes the first element from an array and returns it.

    Returns InboundNatRule | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): InboundNatRule[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns InboundNatRule[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: InboundNatRule, index: number, array: InboundNatRule[]): boolean
        • Parameters

          • value: InboundNatRule
          • index: number
          • array: InboundNatRule[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): InboundNatRule[]
  • splice(start: number, deleteCount: number, ...items: InboundNatRule[]): InboundNatRule[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns InboundNatRule[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: InboundNatRule[]

      Elements to insert into the array in place of the deleted elements.

    Returns InboundNatRule[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: InboundNatRule[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: InboundNatRule[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<InboundNatRule>
  • Returns an iterable of values in the array

    Returns IterableIterator<InboundNatRule>

type

type: object

className

className: string = "InboundNatRuleListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "InboundNatRule"

name

name: "Composite" = "Composite"

Const IpTag

IpTag: object

Contains the IpTag associated with the object.

Optional ipTagType

ipTagType: undefined | string

Gets or sets the ipTag type: Example FirstPartyUsage.

serializedName

serializedName: string = "IpTag"

Optional tag

tag: undefined | string

Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc.

type

type: object

className

className: string = "IpTag"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

ipTagType

ipTagType: object

serializedName

serializedName: string = "ipTagType"

type

type: object

name

name: "String" = "String"

tag

tag: object

serializedName

serializedName: string = "tag"

type

type: object

name

name: "String" = "String"

Const IpsecPolicy

IpsecPolicy: object

An IPSec Policy configuration for a virtual network gateway connection.

dhGroup

dhGroup: DhGroup

The DH Group used in IKE Phase 1 for initial SA. Possible values include: 'None', 'DHGroup1', 'DHGroup2', 'DHGroup14', 'DHGroup2048', 'ECP256', 'ECP384', 'DHGroup24'

ikeEncryption

ikeEncryption: IkeEncryption

The IKE encryption algorithm (IKE phase 2). Possible values include: 'DES', 'DES3', 'AES128', 'AES192', 'AES256', 'GCMAES256', 'GCMAES128'

ikeIntegrity

ikeIntegrity: IkeIntegrity

The IKE integrity algorithm (IKE phase 2). Possible values include: 'MD5', 'SHA1', 'SHA256', 'SHA384', 'GCMAES256', 'GCMAES128'

ipsecEncryption

ipsecEncryption: IpsecEncryption

The IPSec encryption algorithm (IKE phase 1). Possible values include: 'None', 'DES', 'DES3', 'AES128', 'AES192', 'AES256', 'GCMAES128', 'GCMAES192', 'GCMAES256'

ipsecIntegrity

ipsecIntegrity: IpsecIntegrity

The IPSec integrity algorithm (IKE phase 1). Possible values include: 'MD5', 'SHA1', 'SHA256', 'GCMAES128', 'GCMAES192', 'GCMAES256'

pfsGroup

pfsGroup: PfsGroup

The Pfs Group used in IKE Phase 2 for new child SA. Possible values include: 'None', 'PFS1', 'PFS2', 'PFS2048', 'ECP256', 'ECP384', 'PFS24', 'PFS14', 'PFSMM'

saDataSizeKilobytes

saDataSizeKilobytes: number

The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.

saLifeTimeSeconds

saLifeTimeSeconds: number

The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.

serializedName

serializedName: string = "IpsecPolicy"

type

type: object

className

className: string = "IpsecPolicy"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dhGroup

dhGroup: object

required

required: true = true

serializedName

serializedName: string = "dhGroup"

type

type: object

name

name: "String" = "String"

ikeEncryption

ikeEncryption: object

required

required: true = true

serializedName

serializedName: string = "ikeEncryption"

type

type: object

name

name: "String" = "String"

ikeIntegrity

ikeIntegrity: object

required

required: true = true

serializedName

serializedName: string = "ikeIntegrity"

type

type: object

name

name: "String" = "String"

ipsecEncryption

ipsecEncryption: object

required

required: true = true

serializedName

serializedName: string = "ipsecEncryption"

type

type: object

name

name: "String" = "String"

ipsecIntegrity

ipsecIntegrity: object

required

required: true = true

serializedName

serializedName: string = "ipsecIntegrity"

type

type: object

name

name: "String" = "String"

pfsGroup

pfsGroup: object

required

required: true = true

serializedName

serializedName: string = "pfsGroup"

type

type: object

name

name: "String" = "String"

saDataSizeKilobytes

saDataSizeKilobytes: object

required

required: true = true

serializedName

serializedName: string = "saDataSizeKilobytes"

type

type: object

name

name: "Number" = "Number"

saLifeTimeSeconds

saLifeTimeSeconds: object

required

required: true = true

serializedName

serializedName: string = "saLifeTimeSeconds"

type

type: object

name

name: "Number" = "Number"

Const Ipv6ExpressRouteCircuitPeeringConfig

Ipv6ExpressRouteCircuitPeeringConfig: object

Contains IPv6 peering config.

Optional microsoftPeeringConfig

microsoftPeeringConfig: ExpressRouteCircuitPeeringConfig

The Microsoft peering configuration.

Optional primaryPeerAddressPrefix

primaryPeerAddressPrefix: undefined | string

The primary address prefix.

Optional routeFilter

routeFilter: SubResource

The reference of the RouteFilter resource.

Optional secondaryPeerAddressPrefix

secondaryPeerAddressPrefix: undefined | string

The secondary address prefix.

serializedName

serializedName: string = "Ipv6ExpressRouteCircuitPeeringConfig"

Optional state

The state of peering. Possible values include: 'Disabled', 'Enabled'

type

type: object

className

className: string = "Ipv6ExpressRouteCircuitPeeringConfig"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

microsoftPeeringConfig

microsoftPeeringConfig: object

serializedName

serializedName: string = "microsoftPeeringConfig"

type

type: object

className

className: string = "ExpressRouteCircuitPeeringConfig"

name

name: "Composite" = "Composite"

primaryPeerAddressPrefix

primaryPeerAddressPrefix: object

serializedName

serializedName: string = "primaryPeerAddressPrefix"

type

type: object

name

name: "String" = "String"

routeFilter

routeFilter: object

serializedName

serializedName: string = "routeFilter"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

secondaryPeerAddressPrefix

secondaryPeerAddressPrefix: object

serializedName

serializedName: string = "secondaryPeerAddressPrefix"

type

type: object

name

name: "String" = "String"

state

state: object

serializedName

serializedName: string = "state"

type

type: object

name

name: "String" = "String"

Const ListHubVirtualNetworkConnectionsResult

ListHubVirtualNetworkConnectionsResult: object
interface

List of HubVirtualNetworkConnections and a URL nextLink to get the next set of results.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

URL to get the next set of operation list results if there are any.

serializedName

serializedName: string = "ListHubVirtualNetworkConnectionsResult"

__@iterator

  • __@iterator(): IterableIterator<HubVirtualNetworkConnection>
  • Iterator

    Returns IterableIterator<HubVirtualNetworkConnection>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<HubVirtualNetworkConnection>[]): HubVirtualNetworkConnection[]
  • concat(...items: (T | ConcatArray<T>)[]): HubVirtualNetworkConnection[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<HubVirtualNetworkConnection>[]

      Additional items to add to the end of array1.

    Returns HubVirtualNetworkConnection[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns HubVirtualNetworkConnection[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, HubVirtualNetworkConnection]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, HubVirtualNetworkConnection]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: HubVirtualNetworkConnection, index: number, array: HubVirtualNetworkConnection[]): boolean
        • Parameters

          • value: HubVirtualNetworkConnection
          • index: number
          • array: HubVirtualNetworkConnection[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: HubVirtualNetworkConnection, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: HubVirtualNetworkConnection

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): HubVirtualNetworkConnection[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: HubVirtualNetworkConnection

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: HubVirtualNetworkConnection, index: number, array: HubVirtualNetworkConnection[]): boolean
        • Parameters

          • value: HubVirtualNetworkConnection
          • index: number
          • array: HubVirtualNetworkConnection[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: HubVirtualNetworkConnection, index: number, array: HubVirtualNetworkConnection[]): any
        • Parameters

          • value: HubVirtualNetworkConnection
          • index: number
          • array: HubVirtualNetworkConnection[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns HubVirtualNetworkConnection[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): HubVirtualNetworkConnection | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: HubVirtualNetworkConnection

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: HubVirtualNetworkConnection, index: number, obj: HubVirtualNetworkConnection[]): boolean
        • Parameters

          • this: void
          • value: HubVirtualNetworkConnection
          • index: number
          • obj: HubVirtualNetworkConnection[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: HubVirtualNetworkConnection, index: number, obj: HubVirtualNetworkConnection[]): boolean
        • Parameters

          • value: HubVirtualNetworkConnection
          • index: number
          • obj: HubVirtualNetworkConnection[]

          Returns boolean

    • Optional thisArg: any

    Returns HubVirtualNetworkConnection | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: HubVirtualNetworkConnection, index: number, obj: HubVirtualNetworkConnection[]): boolean
        • Parameters

          • value: HubVirtualNetworkConnection
          • index: number
          • obj: HubVirtualNetworkConnection[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: HubVirtualNetworkConnection, index: number, array: HubVirtualNetworkConnection[]): void
        • Parameters

          • value: HubVirtualNetworkConnection
          • index: number
          • array: HubVirtualNetworkConnection[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: HubVirtualNetworkConnection, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: HubVirtualNetworkConnection

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: HubVirtualNetworkConnection, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: HubVirtualNetworkConnection

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: HubVirtualNetworkConnection, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: HubVirtualNetworkConnection

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: HubVirtualNetworkConnection, index: number, array: HubVirtualNetworkConnection[]): U
        • Parameters

          • value: HubVirtualNetworkConnection
          • index: number
          • array: HubVirtualNetworkConnection[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): HubVirtualNetworkConnection | undefined
  • Removes the last element from an array and returns it.

    Returns HubVirtualNetworkConnection | undefined

push

  • push(...items: HubVirtualNetworkConnection[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: HubVirtualNetworkConnection[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): HubVirtualNetworkConnection
  • reduce(callbackfn: function, initialValue: HubVirtualNetworkConnection): HubVirtualNetworkConnection
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: HubVirtualNetworkConnection, currentValue: HubVirtualNetworkConnection, currentIndex: number, array: HubVirtualNetworkConnection[]): HubVirtualNetworkConnection
        • Parameters

          • previousValue: HubVirtualNetworkConnection
          • currentValue: HubVirtualNetworkConnection
          • currentIndex: number
          • array: HubVirtualNetworkConnection[]

          Returns HubVirtualNetworkConnection

    Returns HubVirtualNetworkConnection

  • Parameters

    • callbackfn: function
        • (previousValue: HubVirtualNetworkConnection, currentValue: HubVirtualNetworkConnection, currentIndex: number, array: HubVirtualNetworkConnection[]): HubVirtualNetworkConnection
        • Parameters

          • previousValue: HubVirtualNetworkConnection
          • currentValue: HubVirtualNetworkConnection
          • currentIndex: number
          • array: HubVirtualNetworkConnection[]

          Returns HubVirtualNetworkConnection

    • initialValue: HubVirtualNetworkConnection

    Returns HubVirtualNetworkConnection

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: HubVirtualNetworkConnection, currentIndex: number, array: HubVirtualNetworkConnection[]): U
        • Parameters

          • previousValue: U
          • currentValue: HubVirtualNetworkConnection
          • currentIndex: number
          • array: HubVirtualNetworkConnection[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): HubVirtualNetworkConnection
  • reduceRight(callbackfn: function, initialValue: HubVirtualNetworkConnection): HubVirtualNetworkConnection
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: HubVirtualNetworkConnection, currentValue: HubVirtualNetworkConnection, currentIndex: number, array: HubVirtualNetworkConnection[]): HubVirtualNetworkConnection
        • Parameters

          • previousValue: HubVirtualNetworkConnection
          • currentValue: HubVirtualNetworkConnection
          • currentIndex: number
          • array: HubVirtualNetworkConnection[]

          Returns HubVirtualNetworkConnection

    Returns HubVirtualNetworkConnection

  • Parameters

    • callbackfn: function
        • (previousValue: HubVirtualNetworkConnection, currentValue: HubVirtualNetworkConnection, currentIndex: number, array: HubVirtualNetworkConnection[]): HubVirtualNetworkConnection
        • Parameters

          • previousValue: HubVirtualNetworkConnection
          • currentValue: HubVirtualNetworkConnection
          • currentIndex: number
          • array: HubVirtualNetworkConnection[]

          Returns HubVirtualNetworkConnection

    • initialValue: HubVirtualNetworkConnection

    Returns HubVirtualNetworkConnection

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: HubVirtualNetworkConnection, currentIndex: number, array: HubVirtualNetworkConnection[]): U
        • Parameters

          • previousValue: U
          • currentValue: HubVirtualNetworkConnection
          • currentIndex: number
          • array: HubVirtualNetworkConnection[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): HubVirtualNetworkConnection[]
  • Reverses the elements in an Array.

    Returns HubVirtualNetworkConnection[]

shift

  • shift(): HubVirtualNetworkConnection | undefined
  • Removes the first element from an array and returns it.

    Returns HubVirtualNetworkConnection | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): HubVirtualNetworkConnection[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns HubVirtualNetworkConnection[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: HubVirtualNetworkConnection, index: number, array: HubVirtualNetworkConnection[]): boolean
        • Parameters

          • value: HubVirtualNetworkConnection
          • index: number
          • array: HubVirtualNetworkConnection[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): HubVirtualNetworkConnection[]
  • splice(start: number, deleteCount: number, ...items: HubVirtualNetworkConnection[]): HubVirtualNetworkConnection[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns HubVirtualNetworkConnection[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: HubVirtualNetworkConnection[]

      Elements to insert into the array in place of the deleted elements.

    Returns HubVirtualNetworkConnection[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: HubVirtualNetworkConnection[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: HubVirtualNetworkConnection[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<HubVirtualNetworkConnection>
  • Returns an iterable of values in the array

    Returns IterableIterator<HubVirtualNetworkConnection>

type

type: object

className

className: string = "ListHubVirtualNetworkConnectionsResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HubVirtualNetworkConnection"

name

name: "Composite" = "Composite"

Const ListP2SVpnGatewaysResult

ListP2SVpnGatewaysResult: object
interface

Result of the request to list P2SVpnGateways. It contains a list of P2SVpnGateways and a URL nextLink to get the next set of results.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

URL to get the next set of operation list results if there are any.

serializedName

serializedName: string = "ListP2SVpnGatewaysResult"

__@iterator

  • __@iterator(): IterableIterator<P2SVpnGateway>
  • Iterator

    Returns IterableIterator<P2SVpnGateway>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<P2SVpnGateway>[]): P2SVpnGateway[]
  • concat(...items: (T | ConcatArray<T>)[]): P2SVpnGateway[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<P2SVpnGateway>[]

      Additional items to add to the end of array1.

    Returns P2SVpnGateway[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns P2SVpnGateway[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, P2SVpnGateway]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, P2SVpnGateway]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: P2SVpnGateway, index: number, array: P2SVpnGateway[]): boolean
        • Parameters

          • value: P2SVpnGateway
          • index: number
          • array: P2SVpnGateway[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: P2SVpnGateway, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: P2SVpnGateway

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): P2SVpnGateway[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: P2SVpnGateway

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: P2SVpnGateway, index: number, array: P2SVpnGateway[]): boolean
        • Parameters

          • value: P2SVpnGateway
          • index: number
          • array: P2SVpnGateway[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: P2SVpnGateway, index: number, array: P2SVpnGateway[]): any
        • Parameters

          • value: P2SVpnGateway
          • index: number
          • array: P2SVpnGateway[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns P2SVpnGateway[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): P2SVpnGateway | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: P2SVpnGateway

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: P2SVpnGateway, index: number, obj: P2SVpnGateway[]): boolean
        • Parameters

          • this: void
          • value: P2SVpnGateway
          • index: number
          • obj: P2SVpnGateway[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: P2SVpnGateway, index: number, obj: P2SVpnGateway[]): boolean
        • Parameters

          • value: P2SVpnGateway
          • index: number
          • obj: P2SVpnGateway[]

          Returns boolean

    • Optional thisArg: any

    Returns P2SVpnGateway | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: P2SVpnGateway, index: number, obj: P2SVpnGateway[]): boolean
        • Parameters

          • value: P2SVpnGateway
          • index: number
          • obj: P2SVpnGateway[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: P2SVpnGateway, index: number, array: P2SVpnGateway[]): void
        • Parameters

          • value: P2SVpnGateway
          • index: number
          • array: P2SVpnGateway[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: P2SVpnGateway, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: P2SVpnGateway

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: P2SVpnGateway, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: P2SVpnGateway

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: P2SVpnGateway, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: P2SVpnGateway

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: P2SVpnGateway, index: number, array: P2SVpnGateway[]): U
        • Parameters

          • value: P2SVpnGateway
          • index: number
          • array: P2SVpnGateway[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): P2SVpnGateway | undefined
  • Removes the last element from an array and returns it.

    Returns P2SVpnGateway | undefined

push

  • push(...items: P2SVpnGateway[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: P2SVpnGateway[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): P2SVpnGateway
  • reduce(callbackfn: function, initialValue: P2SVpnGateway): P2SVpnGateway
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: P2SVpnGateway, currentValue: P2SVpnGateway, currentIndex: number, array: P2SVpnGateway[]): P2SVpnGateway
        • Parameters

          • previousValue: P2SVpnGateway
          • currentValue: P2SVpnGateway
          • currentIndex: number
          • array: P2SVpnGateway[]

          Returns P2SVpnGateway

    Returns P2SVpnGateway

  • Parameters

    • callbackfn: function
        • (previousValue: P2SVpnGateway, currentValue: P2SVpnGateway, currentIndex: number, array: P2SVpnGateway[]): P2SVpnGateway
        • Parameters

          • previousValue: P2SVpnGateway
          • currentValue: P2SVpnGateway
          • currentIndex: number
          • array: P2SVpnGateway[]

          Returns P2SVpnGateway

    • initialValue: P2SVpnGateway

    Returns P2SVpnGateway

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: P2SVpnGateway, currentIndex: number, array: P2SVpnGateway[]): U
        • Parameters

          • previousValue: U
          • currentValue: P2SVpnGateway
          • currentIndex: number
          • array: P2SVpnGateway[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): P2SVpnGateway
  • reduceRight(callbackfn: function, initialValue: P2SVpnGateway): P2SVpnGateway
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: P2SVpnGateway, currentValue: P2SVpnGateway, currentIndex: number, array: P2SVpnGateway[]): P2SVpnGateway
        • Parameters

          • previousValue: P2SVpnGateway
          • currentValue: P2SVpnGateway
          • currentIndex: number
          • array: P2SVpnGateway[]

          Returns P2SVpnGateway

    Returns P2SVpnGateway

  • Parameters

    • callbackfn: function
        • (previousValue: P2SVpnGateway, currentValue: P2SVpnGateway, currentIndex: number, array: P2SVpnGateway[]): P2SVpnGateway
        • Parameters

          • previousValue: P2SVpnGateway
          • currentValue: P2SVpnGateway
          • currentIndex: number
          • array: P2SVpnGateway[]

          Returns P2SVpnGateway

    • initialValue: P2SVpnGateway

    Returns P2SVpnGateway

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: P2SVpnGateway, currentIndex: number, array: P2SVpnGateway[]): U
        • Parameters

          • previousValue: U
          • currentValue: P2SVpnGateway
          • currentIndex: number
          • array: P2SVpnGateway[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): P2SVpnGateway[]
  • Reverses the elements in an Array.

    Returns P2SVpnGateway[]

shift

  • shift(): P2SVpnGateway | undefined
  • Removes the first element from an array and returns it.

    Returns P2SVpnGateway | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): P2SVpnGateway[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns P2SVpnGateway[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: P2SVpnGateway, index: number, array: P2SVpnGateway[]): boolean
        • Parameters

          • value: P2SVpnGateway
          • index: number
          • array: P2SVpnGateway[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): P2SVpnGateway[]
  • splice(start: number, deleteCount: number, ...items: P2SVpnGateway[]): P2SVpnGateway[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns P2SVpnGateway[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: P2SVpnGateway[]

      Elements to insert into the array in place of the deleted elements.

    Returns P2SVpnGateway[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: P2SVpnGateway[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: P2SVpnGateway[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<P2SVpnGateway>
  • Returns an iterable of values in the array

    Returns IterableIterator<P2SVpnGateway>

type

type: object

className

className: string = "ListP2SVpnGatewaysResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "P2SVpnGateway"

name

name: "Composite" = "Composite"

Const ListP2SVpnServerConfigurationsResult

ListP2SVpnServerConfigurationsResult: object
interface

Result of the request to list all P2SVpnServerConfigurations associated to a VirtualWan. It contains a list of P2SVpnServerConfigurations and a URL nextLink to get the next set of results.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

URL to get the next set of operation list results if there are any.

serializedName

serializedName: string = "ListP2SVpnServerConfigurationsResult"

__@iterator

  • __@iterator(): IterableIterator<P2SVpnServerConfiguration>
  • Iterator

    Returns IterableIterator<P2SVpnServerConfiguration>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<P2SVpnServerConfiguration>[]): P2SVpnServerConfiguration[]
  • concat(...items: (T | ConcatArray<T>)[]): P2SVpnServerConfiguration[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<P2SVpnServerConfiguration>[]

      Additional items to add to the end of array1.

    Returns P2SVpnServerConfiguration[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns P2SVpnServerConfiguration[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, P2SVpnServerConfiguration]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, P2SVpnServerConfiguration]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: P2SVpnServerConfiguration, index: number, array: P2SVpnServerConfiguration[]): boolean
        • Parameters

          • value: P2SVpnServerConfiguration
          • index: number
          • array: P2SVpnServerConfiguration[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: P2SVpnServerConfiguration, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: P2SVpnServerConfiguration

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): P2SVpnServerConfiguration[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: P2SVpnServerConfiguration

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: P2SVpnServerConfiguration, index: number, array: P2SVpnServerConfiguration[]): boolean
        • Parameters

          • value: P2SVpnServerConfiguration
          • index: number
          • array: P2SVpnServerConfiguration[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: P2SVpnServerConfiguration, index: number, array: P2SVpnServerConfiguration[]): any
        • Parameters

          • value: P2SVpnServerConfiguration
          • index: number
          • array: P2SVpnServerConfiguration[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns P2SVpnServerConfiguration[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): P2SVpnServerConfiguration | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: P2SVpnServerConfiguration

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: P2SVpnServerConfiguration, index: number, obj: P2SVpnServerConfiguration[]): boolean
        • Parameters

          • this: void
          • value: P2SVpnServerConfiguration
          • index: number
          • obj: P2SVpnServerConfiguration[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: P2SVpnServerConfiguration, index: number, obj: P2SVpnServerConfiguration[]): boolean
        • Parameters

          • value: P2SVpnServerConfiguration
          • index: number
          • obj: P2SVpnServerConfiguration[]

          Returns boolean

    • Optional thisArg: any

    Returns P2SVpnServerConfiguration | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: P2SVpnServerConfiguration, index: number, obj: P2SVpnServerConfiguration[]): boolean
        • Parameters

          • value: P2SVpnServerConfiguration
          • index: number
          • obj: P2SVpnServerConfiguration[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: P2SVpnServerConfiguration, index: number, array: P2SVpnServerConfiguration[]): void
        • Parameters

          • value: P2SVpnServerConfiguration
          • index: number
          • array: P2SVpnServerConfiguration[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: P2SVpnServerConfiguration, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: P2SVpnServerConfiguration

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: P2SVpnServerConfiguration, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: P2SVpnServerConfiguration

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: P2SVpnServerConfiguration, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: P2SVpnServerConfiguration

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: P2SVpnServerConfiguration, index: number, array: P2SVpnServerConfiguration[]): U
        • Parameters

          • value: P2SVpnServerConfiguration
          • index: number
          • array: P2SVpnServerConfiguration[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): P2SVpnServerConfiguration | undefined
  • Removes the last element from an array and returns it.

    Returns P2SVpnServerConfiguration | undefined

push

  • push(...items: P2SVpnServerConfiguration[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: P2SVpnServerConfiguration[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): P2SVpnServerConfiguration
  • reduce(callbackfn: function, initialValue: P2SVpnServerConfiguration): P2SVpnServerConfiguration
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: P2SVpnServerConfiguration, currentValue: P2SVpnServerConfiguration, currentIndex: number, array: P2SVpnServerConfiguration[]): P2SVpnServerConfiguration
        • Parameters

          • previousValue: P2SVpnServerConfiguration
          • currentValue: P2SVpnServerConfiguration
          • currentIndex: number
          • array: P2SVpnServerConfiguration[]

          Returns P2SVpnServerConfiguration

    Returns P2SVpnServerConfiguration

  • Parameters

    • callbackfn: function
        • (previousValue: P2SVpnServerConfiguration, currentValue: P2SVpnServerConfiguration, currentIndex: number, array: P2SVpnServerConfiguration[]): P2SVpnServerConfiguration
        • Parameters

          • previousValue: P2SVpnServerConfiguration
          • currentValue: P2SVpnServerConfiguration
          • currentIndex: number
          • array: P2SVpnServerConfiguration[]

          Returns P2SVpnServerConfiguration

    • initialValue: P2SVpnServerConfiguration

    Returns P2SVpnServerConfiguration

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: P2SVpnServerConfiguration, currentIndex: number, array: P2SVpnServerConfiguration[]): U
        • Parameters

          • previousValue: U
          • currentValue: P2SVpnServerConfiguration
          • currentIndex: number
          • array: P2SVpnServerConfiguration[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): P2SVpnServerConfiguration
  • reduceRight(callbackfn: function, initialValue: P2SVpnServerConfiguration): P2SVpnServerConfiguration
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: P2SVpnServerConfiguration, currentValue: P2SVpnServerConfiguration, currentIndex: number, array: P2SVpnServerConfiguration[]): P2SVpnServerConfiguration
        • Parameters

          • previousValue: P2SVpnServerConfiguration
          • currentValue: P2SVpnServerConfiguration
          • currentIndex: number
          • array: P2SVpnServerConfiguration[]

          Returns P2SVpnServerConfiguration

    Returns P2SVpnServerConfiguration

  • Parameters

    • callbackfn: function
        • (previousValue: P2SVpnServerConfiguration, currentValue: P2SVpnServerConfiguration, currentIndex: number, array: P2SVpnServerConfiguration[]): P2SVpnServerConfiguration
        • Parameters

          • previousValue: P2SVpnServerConfiguration
          • currentValue: P2SVpnServerConfiguration
          • currentIndex: number
          • array: P2SVpnServerConfiguration[]

          Returns P2SVpnServerConfiguration

    • initialValue: P2SVpnServerConfiguration

    Returns P2SVpnServerConfiguration

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: P2SVpnServerConfiguration, currentIndex: number, array: P2SVpnServerConfiguration[]): U
        • Parameters

          • previousValue: U
          • currentValue: P2SVpnServerConfiguration
          • currentIndex: number
          • array: P2SVpnServerConfiguration[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): P2SVpnServerConfiguration[]
  • Reverses the elements in an Array.

    Returns P2SVpnServerConfiguration[]

shift

  • shift(): P2SVpnServerConfiguration | undefined
  • Removes the first element from an array and returns it.

    Returns P2SVpnServerConfiguration | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): P2SVpnServerConfiguration[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns P2SVpnServerConfiguration[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: P2SVpnServerConfiguration, index: number, array: P2SVpnServerConfiguration[]): boolean
        • Parameters

          • value: P2SVpnServerConfiguration
          • index: number
          • array: P2SVpnServerConfiguration[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): P2SVpnServerConfiguration[]
  • splice(start: number, deleteCount: number, ...items: P2SVpnServerConfiguration[]): P2SVpnServerConfiguration[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns P2SVpnServerConfiguration[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: P2SVpnServerConfiguration[]

      Elements to insert into the array in place of the deleted elements.

    Returns P2SVpnServerConfiguration[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: P2SVpnServerConfiguration[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: P2SVpnServerConfiguration[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<P2SVpnServerConfiguration>
  • Returns an iterable of values in the array

    Returns IterableIterator<P2SVpnServerConfiguration>

type

type: object

className

className: string = "ListP2SVpnServerConfigurationsResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "P2SVpnServerConfiguration"

name

name: "Composite" = "Composite"

Const ListVirtualHubsResult

ListVirtualHubsResult: object
interface

Result of the request to list VirtualHubs. It contains a list of VirtualHubs and a URL nextLink to get the next set of results.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

URL to get the next set of operation list results if there are any.

serializedName

serializedName: string = "ListVirtualHubsResult"

__@iterator

  • __@iterator(): IterableIterator<VirtualHub>
  • Iterator

    Returns IterableIterator<VirtualHub>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<VirtualHub>[]): VirtualHub[]
  • concat(...items: (T | ConcatArray<T>)[]): VirtualHub[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<VirtualHub>[]

      Additional items to add to the end of array1.

    Returns VirtualHub[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns VirtualHub[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, VirtualHub]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, VirtualHub]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: VirtualHub, index: number, array: VirtualHub[]): boolean
        • Parameters

          • value: VirtualHub
          • index: number
          • array: VirtualHub[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: VirtualHub, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: VirtualHub

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): VirtualHub[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: VirtualHub

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: VirtualHub, index: number, array: VirtualHub[]): boolean
        • Parameters

          • value: VirtualHub
          • index: number
          • array: VirtualHub[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: VirtualHub, index: number, array: VirtualHub[]): any
        • Parameters

          • value: VirtualHub
          • index: number
          • array: VirtualHub[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns VirtualHub[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): VirtualHub | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: VirtualHub

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: VirtualHub, index: number, obj: VirtualHub[]): boolean
        • Parameters

          • this: void
          • value: VirtualHub
          • index: number
          • obj: VirtualHub[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: VirtualHub, index: number, obj: VirtualHub[]): boolean
        • Parameters

          • value: VirtualHub
          • index: number
          • obj: VirtualHub[]

          Returns boolean

    • Optional thisArg: any

    Returns VirtualHub | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: VirtualHub, index: number, obj: VirtualHub[]): boolean
        • Parameters

          • value: VirtualHub
          • index: number
          • obj: VirtualHub[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: VirtualHub, index: number, array: VirtualHub[]): void
        • Parameters

          • value: VirtualHub
          • index: number
          • array: VirtualHub[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: VirtualHub, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: VirtualHub

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: VirtualHub, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: VirtualHub

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: VirtualHub, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: VirtualHub

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: VirtualHub, index: number, array: VirtualHub[]): U
        • Parameters

          • value: VirtualHub
          • index: number
          • array: VirtualHub[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): VirtualHub | undefined
  • Removes the last element from an array and returns it.

    Returns VirtualHub | undefined

push

  • push(...items: VirtualHub[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: VirtualHub[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): VirtualHub
  • reduce(callbackfn: function, initialValue: VirtualHub): VirtualHub
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: VirtualHub, currentValue: VirtualHub, currentIndex: number, array: VirtualHub[]): VirtualHub
        • Parameters

          • previousValue: VirtualHub
          • currentValue: VirtualHub
          • currentIndex: number
          • array: VirtualHub[]

          Returns VirtualHub

    Returns VirtualHub

  • Parameters

    • callbackfn: function
        • (previousValue: VirtualHub, currentValue: VirtualHub, currentIndex: number, array: VirtualHub[]): VirtualHub
        • Parameters

          • previousValue: VirtualHub
          • currentValue: VirtualHub
          • currentIndex: number
          • array: VirtualHub[]

          Returns VirtualHub

    • initialValue: VirtualHub

    Returns VirtualHub

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: VirtualHub, currentIndex: number, array: VirtualHub[]): U
        • Parameters

          • previousValue: U
          • currentValue: VirtualHub
          • currentIndex: number
          • array: VirtualHub[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): VirtualHub
  • reduceRight(callbackfn: function, initialValue: VirtualHub): VirtualHub
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: VirtualHub, currentValue: VirtualHub, currentIndex: number, array: VirtualHub[]): VirtualHub
        • Parameters

          • previousValue: VirtualHub
          • currentValue: VirtualHub
          • currentIndex: number
          • array: VirtualHub[]

          Returns VirtualHub

    Returns VirtualHub

  • Parameters

    • callbackfn: function
        • (previousValue: VirtualHub, currentValue: VirtualHub, currentIndex: number, array: VirtualHub[]): VirtualHub
        • Parameters

          • previousValue: VirtualHub
          • currentValue: VirtualHub
          • currentIndex: number
          • array: VirtualHub[]

          Returns VirtualHub

    • initialValue: VirtualHub

    Returns VirtualHub

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: VirtualHub, currentIndex: number, array: VirtualHub[]): U
        • Parameters

          • previousValue: U
          • currentValue: VirtualHub
          • currentIndex: number
          • array: VirtualHub[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): VirtualHub[]
  • Reverses the elements in an Array.

    Returns VirtualHub[]

shift

  • shift(): VirtualHub | undefined
  • Removes the first element from an array and returns it.

    Returns VirtualHub | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): VirtualHub[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns VirtualHub[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: VirtualHub, index: number, array: VirtualHub[]): boolean
        • Parameters

          • value: VirtualHub
          • index: number
          • array: VirtualHub[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): VirtualHub[]
  • splice(start: number, deleteCount: number, ...items: VirtualHub[]): VirtualHub[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns VirtualHub[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: VirtualHub[]

      Elements to insert into the array in place of the deleted elements.

    Returns VirtualHub[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: VirtualHub[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: VirtualHub[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<VirtualHub>
  • Returns an iterable of values in the array

    Returns IterableIterator<VirtualHub>

type

type: object

className

className: string = "ListVirtualHubsResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VirtualHub"

name

name: "Composite" = "Composite"

Const ListVirtualWANsResult

ListVirtualWANsResult: object
interface

Result of the request to list VirtualWANs. It contains a list of VirtualWANs and a URL nextLink to get the next set of results.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

URL to get the next set of operation list results if there are any.

serializedName

serializedName: string = "ListVirtualWANsResult"

__@iterator

  • __@iterator(): IterableIterator<VirtualWAN>
  • Iterator

    Returns IterableIterator<VirtualWAN>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<VirtualWAN>[]): VirtualWAN[]
  • concat(...items: (T | ConcatArray<T>)[]): VirtualWAN[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<VirtualWAN>[]

      Additional items to add to the end of array1.

    Returns VirtualWAN[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns VirtualWAN[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, VirtualWAN]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, VirtualWAN]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: VirtualWAN, index: number, array: VirtualWAN[]): boolean
        • Parameters

          • value: VirtualWAN
          • index: number
          • array: VirtualWAN[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: VirtualWAN, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: VirtualWAN

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): VirtualWAN[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: VirtualWAN

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: VirtualWAN, index: number, array: VirtualWAN[]): boolean
        • Parameters

          • value: VirtualWAN
          • index: number
          • array: VirtualWAN[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: VirtualWAN, index: number, array: VirtualWAN[]): any
        • Parameters

          • value: VirtualWAN
          • index: number
          • array: VirtualWAN[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns VirtualWAN[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): VirtualWAN | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: VirtualWAN

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: VirtualWAN, index: number, obj: VirtualWAN[]): boolean
        • Parameters

          • this: void
          • value: VirtualWAN
          • index: number
          • obj: VirtualWAN[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: VirtualWAN, index: number, obj: VirtualWAN[]): boolean
        • Parameters

          • value: VirtualWAN
          • index: number
          • obj: VirtualWAN[]

          Returns boolean

    • Optional thisArg: any

    Returns VirtualWAN | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: VirtualWAN, index: number, obj: VirtualWAN[]): boolean
        • Parameters

          • value: VirtualWAN
          • index: number
          • obj: VirtualWAN[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: VirtualWAN, index: number, array: VirtualWAN[]): void
        • Parameters

          • value: VirtualWAN
          • index: number
          • array: VirtualWAN[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: VirtualWAN, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: VirtualWAN

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: VirtualWAN, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: VirtualWAN

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: VirtualWAN, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: VirtualWAN

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: VirtualWAN, index: number, array: VirtualWAN[]): U
        • Parameters

          • value: VirtualWAN
          • index: number
          • array: VirtualWAN[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): VirtualWAN | undefined
  • Removes the last element from an array and returns it.

    Returns VirtualWAN | undefined

push

  • push(...items: VirtualWAN[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: VirtualWAN[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): VirtualWAN
  • reduce(callbackfn: function, initialValue: VirtualWAN): VirtualWAN
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: VirtualWAN, currentValue: VirtualWAN, currentIndex: number, array: VirtualWAN[]): VirtualWAN
        • Parameters

          • previousValue: VirtualWAN
          • currentValue: VirtualWAN
          • currentIndex: number
          • array: VirtualWAN[]

          Returns VirtualWAN

    Returns VirtualWAN

  • Parameters

    • callbackfn: function
        • (previousValue: VirtualWAN, currentValue: VirtualWAN, currentIndex: number, array: VirtualWAN[]): VirtualWAN
        • Parameters

          • previousValue: VirtualWAN
          • currentValue: VirtualWAN
          • currentIndex: number
          • array: VirtualWAN[]

          Returns VirtualWAN

    • initialValue: VirtualWAN

    Returns VirtualWAN

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: VirtualWAN, currentIndex: number, array: VirtualWAN[]): U
        • Parameters

          • previousValue: U
          • currentValue: VirtualWAN
          • currentIndex: number
          • array: VirtualWAN[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): VirtualWAN
  • reduceRight(callbackfn: function, initialValue: VirtualWAN): VirtualWAN
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: VirtualWAN, currentValue: VirtualWAN, currentIndex: number, array: VirtualWAN[]): VirtualWAN
        • Parameters

          • previousValue: VirtualWAN
          • currentValue: VirtualWAN
          • currentIndex: number
          • array: VirtualWAN[]

          Returns VirtualWAN

    Returns VirtualWAN

  • Parameters

    • callbackfn: function
        • (previousValue: VirtualWAN, currentValue: VirtualWAN, currentIndex: number, array: VirtualWAN[]): VirtualWAN
        • Parameters

          • previousValue: VirtualWAN
          • currentValue: VirtualWAN
          • currentIndex: number
          • array: VirtualWAN[]

          Returns VirtualWAN

    • initialValue: VirtualWAN

    Returns VirtualWAN

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: VirtualWAN, currentIndex: number, array: VirtualWAN[]): U
        • Parameters

          • previousValue: U
          • currentValue: VirtualWAN
          • currentIndex: number
          • array: VirtualWAN[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): VirtualWAN[]
  • Reverses the elements in an Array.

    Returns VirtualWAN[]

shift

  • shift(): VirtualWAN | undefined
  • Removes the first element from an array and returns it.

    Returns VirtualWAN | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): VirtualWAN[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns VirtualWAN[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: VirtualWAN, index: number, array: VirtualWAN[]): boolean
        • Parameters

          • value: VirtualWAN
          • index: number
          • array: VirtualWAN[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): VirtualWAN[]
  • splice(start: number, deleteCount: number, ...items: VirtualWAN[]): VirtualWAN[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns VirtualWAN[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: VirtualWAN[]

      Elements to insert into the array in place of the deleted elements.

    Returns VirtualWAN[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: VirtualWAN[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: VirtualWAN[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<VirtualWAN>
  • Returns an iterable of values in the array

    Returns IterableIterator<VirtualWAN>

type

type: object

className

className: string = "ListVirtualWANsResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VirtualWAN"

name

name: "Composite" = "Composite"

Const ListVpnConnectionsResult

ListVpnConnectionsResult: object
interface

Result of the request to list all vpn connections to a virtual wan vpn gateway. It contains a list of Vpn Connections and a URL nextLink to get the next set of results.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

URL to get the next set of operation list results if there are any.

serializedName

serializedName: string = "ListVpnConnectionsResult"

__@iterator

  • __@iterator(): IterableIterator<VpnConnection>
  • Iterator

    Returns IterableIterator<VpnConnection>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<VpnConnection>[]): VpnConnection[]
  • concat(...items: (T | ConcatArray<T>)[]): VpnConnection[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<VpnConnection>[]

      Additional items to add to the end of array1.

    Returns VpnConnection[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns VpnConnection[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, VpnConnection]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, VpnConnection]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: VpnConnection, index: number, array: VpnConnection[]): boolean
        • Parameters

          • value: VpnConnection
          • index: number
          • array: VpnConnection[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: VpnConnection, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: VpnConnection

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): VpnConnection[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: VpnConnection

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: VpnConnection, index: number, array: VpnConnection[]): boolean
        • Parameters

          • value: VpnConnection
          • index: number
          • array: VpnConnection[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: VpnConnection, index: number, array: VpnConnection[]): any
        • Parameters

          • value: VpnConnection
          • index: number
          • array: VpnConnection[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns VpnConnection[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): VpnConnection | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: VpnConnection

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: VpnConnection, index: number, obj: VpnConnection[]): boolean
        • Parameters

          • this: void
          • value: VpnConnection
          • index: number
          • obj: VpnConnection[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: VpnConnection, index: number, obj: VpnConnection[]): boolean
        • Parameters

          • value: VpnConnection
          • index: number
          • obj: VpnConnection[]

          Returns boolean

    • Optional thisArg: any

    Returns VpnConnection | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: VpnConnection, index: number, obj: VpnConnection[]): boolean
        • Parameters

          • value: VpnConnection
          • index: number
          • obj: VpnConnection[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: VpnConnection, index: number, array: VpnConnection[]): void
        • Parameters

          • value: VpnConnection
          • index: number
          • array: VpnConnection[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: VpnConnection, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: VpnConnection

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: VpnConnection, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: VpnConnection

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: VpnConnection, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: VpnConnection

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: VpnConnection, index: number, array: VpnConnection[]): U
        • Parameters

          • value: VpnConnection
          • index: number
          • array: VpnConnection[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): VpnConnection | undefined
  • Removes the last element from an array and returns it.

    Returns VpnConnection | undefined

push

  • push(...items: VpnConnection[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: VpnConnection[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): VpnConnection
  • reduce(callbackfn: function, initialValue: VpnConnection): VpnConnection
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: VpnConnection, currentValue: VpnConnection, currentIndex: number, array: VpnConnection[]): VpnConnection
        • Parameters

          • previousValue: VpnConnection
          • currentValue: VpnConnection
          • currentIndex: number
          • array: VpnConnection[]

          Returns VpnConnection

    Returns VpnConnection

  • Parameters

    • callbackfn: function
        • (previousValue: VpnConnection, currentValue: VpnConnection, currentIndex: number, array: VpnConnection[]): VpnConnection
        • Parameters

          • previousValue: VpnConnection
          • currentValue: VpnConnection
          • currentIndex: number
          • array: VpnConnection[]

          Returns VpnConnection

    • initialValue: VpnConnection

    Returns VpnConnection

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: VpnConnection, currentIndex: number, array: VpnConnection[]): U
        • Parameters

          • previousValue: U
          • currentValue: VpnConnection
          • currentIndex: number
          • array: VpnConnection[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): VpnConnection
  • reduceRight(callbackfn: function, initialValue: VpnConnection): VpnConnection
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: VpnConnection, currentValue: VpnConnection, currentIndex: number, array: VpnConnection[]): VpnConnection
        • Parameters

          • previousValue: VpnConnection
          • currentValue: VpnConnection
          • currentIndex: number
          • array: VpnConnection[]

          Returns VpnConnection

    Returns VpnConnection

  • Parameters

    • callbackfn: function
        • (previousValue: VpnConnection, currentValue: VpnConnection, currentIndex: number, array: VpnConnection[]): VpnConnection
        • Parameters

          • previousValue: VpnConnection
          • currentValue: VpnConnection
          • currentIndex: number
          • array: VpnConnection[]

          Returns VpnConnection

    • initialValue: VpnConnection

    Returns VpnConnection

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: VpnConnection, currentIndex: number, array: VpnConnection[]): U
        • Parameters

          • previousValue: U
          • currentValue: VpnConnection
          • currentIndex: number
          • array: VpnConnection[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): VpnConnection[]
  • Reverses the elements in an Array.

    Returns VpnConnection[]

shift

  • shift(): VpnConnection | undefined
  • Removes the first element from an array and returns it.

    Returns VpnConnection | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): VpnConnection[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns VpnConnection[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: VpnConnection, index: number, array: VpnConnection[]): boolean
        • Parameters

          • value: VpnConnection
          • index: number
          • array: VpnConnection[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): VpnConnection[]
  • splice(start: number, deleteCount: number, ...items: VpnConnection[]): VpnConnection[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns VpnConnection[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: VpnConnection[]

      Elements to insert into the array in place of the deleted elements.

    Returns VpnConnection[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: VpnConnection[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: VpnConnection[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<VpnConnection>
  • Returns an iterable of values in the array

    Returns IterableIterator<VpnConnection>

type

type: object

className

className: string = "ListVpnConnectionsResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VpnConnection"

name

name: "Composite" = "Composite"

Const ListVpnGatewaysResult

ListVpnGatewaysResult: object
interface

Result of the request to list VpnGateways. It contains a list of VpnGateways and a URL nextLink to get the next set of results.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

URL to get the next set of operation list results if there are any.

serializedName

serializedName: string = "ListVpnGatewaysResult"

__@iterator

  • __@iterator(): IterableIterator<VpnGateway>
  • Iterator

    Returns IterableIterator<VpnGateway>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<VpnGateway>[]): VpnGateway[]
  • concat(...items: (T | ConcatArray<T>)[]): VpnGateway[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<VpnGateway>[]

      Additional items to add to the end of array1.

    Returns VpnGateway[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns VpnGateway[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, VpnGateway]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, VpnGateway]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: VpnGateway, index: number, array: VpnGateway[]): boolean
        • Parameters

          • value: VpnGateway
          • index: number
          • array: VpnGateway[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: VpnGateway, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: VpnGateway

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): VpnGateway[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: VpnGateway

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: VpnGateway, index: number, array: VpnGateway[]): boolean
        • Parameters

          • value: VpnGateway
          • index: number
          • array: VpnGateway[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: VpnGateway, index: number, array: VpnGateway[]): any
        • Parameters

          • value: VpnGateway
          • index: number
          • array: VpnGateway[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns VpnGateway[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): VpnGateway | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: VpnGateway

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: VpnGateway, index: number, obj: VpnGateway[]): boolean
        • Parameters

          • this: void
          • value: VpnGateway
          • index: number
          • obj: VpnGateway[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: VpnGateway, index: number, obj: VpnGateway[]): boolean
        • Parameters

          • value: VpnGateway
          • index: number
          • obj: VpnGateway[]

          Returns boolean

    • Optional thisArg: any

    Returns VpnGateway | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: VpnGateway, index: number, obj: VpnGateway[]): boolean
        • Parameters

          • value: VpnGateway
          • index: number
          • obj: VpnGateway[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: VpnGateway, index: number, array: VpnGateway[]): void
        • Parameters

          • value: VpnGateway
          • index: number
          • array: VpnGateway[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: VpnGateway, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: VpnGateway

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: VpnGateway, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: VpnGateway

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: VpnGateway, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: VpnGateway

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: VpnGateway, index: number, array: VpnGateway[]): U
        • Parameters

          • value: VpnGateway
          • index: number
          • array: VpnGateway[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): VpnGateway | undefined
  • Removes the last element from an array and returns it.

    Returns VpnGateway | undefined

push

  • push(...items: VpnGateway[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: VpnGateway[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): VpnGateway
  • reduce(callbackfn: function, initialValue: VpnGateway): VpnGateway
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: VpnGateway, currentValue: VpnGateway, currentIndex: number, array: VpnGateway[]): VpnGateway
        • Parameters

          • previousValue: VpnGateway
          • currentValue: VpnGateway
          • currentIndex: number
          • array: VpnGateway[]

          Returns VpnGateway

    Returns VpnGateway

  • Parameters

    • callbackfn: function
        • (previousValue: VpnGateway, currentValue: VpnGateway, currentIndex: number, array: VpnGateway[]): VpnGateway
        • Parameters

          • previousValue: VpnGateway
          • currentValue: VpnGateway
          • currentIndex: number
          • array: VpnGateway[]

          Returns VpnGateway

    • initialValue: VpnGateway

    Returns VpnGateway

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: VpnGateway, currentIndex: number, array: VpnGateway[]): U
        • Parameters

          • previousValue: U
          • currentValue: VpnGateway
          • currentIndex: number
          • array: VpnGateway[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): VpnGateway
  • reduceRight(callbackfn: function, initialValue: VpnGateway): VpnGateway
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: VpnGateway, currentValue: VpnGateway, currentIndex: number, array: VpnGateway[]): VpnGateway
        • Parameters

          • previousValue: VpnGateway
          • currentValue: VpnGateway
          • currentIndex: number
          • array: VpnGateway[]

          Returns VpnGateway

    Returns VpnGateway

  • Parameters

    • callbackfn: function
        • (previousValue: VpnGateway, currentValue: VpnGateway, currentIndex: number, array: VpnGateway[]): VpnGateway
        • Parameters

          • previousValue: VpnGateway
          • currentValue: VpnGateway
          • currentIndex: number
          • array: VpnGateway[]

          Returns VpnGateway

    • initialValue: VpnGateway

    Returns VpnGateway

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: VpnGateway, currentIndex: number, array: VpnGateway[]): U
        • Parameters

          • previousValue: U
          • currentValue: VpnGateway
          • currentIndex: number
          • array: VpnGateway[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): VpnGateway[]
  • Reverses the elements in an Array.

    Returns VpnGateway[]

shift

  • shift(): VpnGateway | undefined
  • Removes the first element from an array and returns it.

    Returns VpnGateway | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): VpnGateway[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns VpnGateway[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: VpnGateway, index: number, array: VpnGateway[]): boolean
        • Parameters

          • value: VpnGateway
          • index: number
          • array: VpnGateway[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): VpnGateway[]
  • splice(start: number, deleteCount: number, ...items: VpnGateway[]): VpnGateway[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns VpnGateway[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: VpnGateway[]

      Elements to insert into the array in place of the deleted elements.

    Returns VpnGateway[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: VpnGateway[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: VpnGateway[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<VpnGateway>
  • Returns an iterable of values in the array

    Returns IterableIterator<VpnGateway>

type

type: object

className

className: string = "ListVpnGatewaysResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VpnGateway"

name

name: "Composite" = "Composite"

Const ListVpnSitesResult

ListVpnSitesResult: object
interface

Result of the request to list VpnSites. It contains a list of VpnSites and a URL nextLink to get the next set of results.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

URL to get the next set of operation list results if there are any.

serializedName

serializedName: string = "ListVpnSitesResult"

__@iterator

  • __@iterator(): IterableIterator<VpnSite>
  • Iterator

    Returns IterableIterator<VpnSite>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<VpnSite>[]): VpnSite[]
  • concat(...items: (T | ConcatArray<T>)[]): VpnSite[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<VpnSite>[]

      Additional items to add to the end of array1.

    Returns VpnSite[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns VpnSite[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, VpnSite]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, VpnSite]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: VpnSite, index: number, array: VpnSite[]): boolean
        • Parameters

          • value: VpnSite
          • index: number
          • array: VpnSite[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: VpnSite, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: VpnSite

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): VpnSite[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: VpnSite

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: VpnSite, index: number, array: VpnSite[]): boolean
        • Parameters

          • value: VpnSite
          • index: number
          • array: VpnSite[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: VpnSite, index: number, array: VpnSite[]): any
        • Parameters

          • value: VpnSite
          • index: number
          • array: VpnSite[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns VpnSite[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): VpnSite | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: VpnSite

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: VpnSite, index: number, obj: VpnSite[]): boolean
        • Parameters

          • this: void
          • value: VpnSite
          • index: number
          • obj: VpnSite[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: VpnSite, index: number, obj: VpnSite[]): boolean
        • Parameters

          • value: VpnSite
          • index: number
          • obj: VpnSite[]

          Returns boolean

    • Optional thisArg: any

    Returns VpnSite | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: VpnSite, index: number, obj: VpnSite[]): boolean
        • Parameters

          • value: VpnSite
          • index: number
          • obj: VpnSite[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: VpnSite, index: number, array: VpnSite[]): void
        • Parameters

          • value: VpnSite
          • index: number
          • array: VpnSite[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: VpnSite, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: VpnSite

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: VpnSite, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: VpnSite

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: VpnSite, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: VpnSite

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: VpnSite, index: number, array: VpnSite[]): U
        • Parameters

          • value: VpnSite
          • index: number
          • array: VpnSite[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): VpnSite | undefined
  • Removes the last element from an array and returns it.

    Returns VpnSite | undefined

push

  • push(...items: VpnSite[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: VpnSite[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): VpnSite
  • reduce(callbackfn: function, initialValue: VpnSite): VpnSite
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: VpnSite, currentValue: VpnSite, currentIndex: number, array: VpnSite[]): VpnSite
        • Parameters

          • previousValue: VpnSite
          • currentValue: VpnSite
          • currentIndex: number
          • array: VpnSite[]

          Returns VpnSite

    Returns VpnSite

  • Parameters

    • callbackfn: function
        • (previousValue: VpnSite, currentValue: VpnSite, currentIndex: number, array: VpnSite[]): VpnSite
        • Parameters

          • previousValue: VpnSite
          • currentValue: VpnSite
          • currentIndex: number
          • array: VpnSite[]

          Returns VpnSite

    • initialValue: VpnSite

    Returns VpnSite

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: VpnSite, currentIndex: number, array: VpnSite[]): U
        • Parameters

          • previousValue: U
          • currentValue: VpnSite
          • currentIndex: number
          • array: VpnSite[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): VpnSite
  • reduceRight(callbackfn: function, initialValue: VpnSite): VpnSite
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: VpnSite, currentValue: VpnSite, currentIndex: number, array: VpnSite[]): VpnSite
        • Parameters

          • previousValue: VpnSite
          • currentValue: VpnSite
          • currentIndex: number
          • array: VpnSite[]

          Returns VpnSite

    Returns VpnSite

  • Parameters

    • callbackfn: function
        • (previousValue: VpnSite, currentValue: VpnSite, currentIndex: number, array: VpnSite[]): VpnSite
        • Parameters

          • previousValue: VpnSite
          • currentValue: VpnSite
          • currentIndex: number
          • array: VpnSite[]

          Returns VpnSite

    • initialValue: VpnSite

    Returns VpnSite

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: VpnSite, currentIndex: number, array: VpnSite[]): U
        • Parameters

          • previousValue: U
          • currentValue: VpnSite
          • currentIndex: number
          • array: VpnSite[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): VpnSite[]
  • Reverses the elements in an Array.

    Returns VpnSite[]

shift

  • shift(): VpnSite | undefined
  • Removes the first element from an array and returns it.

    Returns VpnSite | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): VpnSite[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns VpnSite[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: VpnSite, index: number, array: VpnSite[]): boolean
        • Parameters

          • value: VpnSite
          • index: number
          • array: VpnSite[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): VpnSite[]
  • splice(start: number, deleteCount: number, ...items: VpnSite[]): VpnSite[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns VpnSite[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: VpnSite[]

      Elements to insert into the array in place of the deleted elements.

    Returns VpnSite[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: VpnSite[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: VpnSite[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<VpnSite>
  • Returns an iterable of values in the array

    Returns IterableIterator<VpnSite>

type

type: object

className

className: string = "ListVpnSitesResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VpnSite"

name

name: "Composite" = "Composite"

Const LoadBalancer

LoadBalancer: object

LoadBalancer resource.

Optional backendAddressPools

backendAddressPools: BackendAddressPool[]

Collection of backend address pools used by a load balancer.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional frontendIPConfigurations

frontendIPConfigurations: FrontendIPConfiguration[]

Object representing the frontend IPs to be used for the load balancer.

Optional id

id: undefined | string

Resource ID.

Optional inboundNatPools

inboundNatPools: InboundNatPool[]

Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range. Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound Nat rules. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an inbound NAT pool. They have to reference individual inbound NAT rules.

Optional inboundNatRules

inboundNatRules: InboundNatRule[]

Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules.

Optional loadBalancingRules

loadBalancingRules: LoadBalancingRule[]

Object collection representing the load balancing rules Gets the provisioning.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional outboundRules

outboundRules: OutboundRule[]

The outbound rules.

Optional probes

probes: Probe[]

Collection of probe objects used in the load balancer.

Optional provisioningState

provisioningState: undefined | string

Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

Optional resourceGuid

resourceGuid: undefined | string

The resource GUID property of the load balancer resource.

serializedName

serializedName: string = "LoadBalancer"

Optional sku

The load balancer SKU.

Optional tags

tags: undefined | object

Resource tags.

type

type: object

className

className: string = "LoadBalancer"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backendAddressPools

backendAddressPools: object

serializedName

serializedName: string = "properties.backendAddressPools"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "BackendAddressPool"

name

name: "Composite" = "Composite"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

frontendIPConfigurations

frontendIPConfigurations: object

serializedName

serializedName: string = "properties.frontendIPConfigurations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "FrontendIPConfiguration"

name

name: "Composite" = "Composite"

inboundNatPools

inboundNatPools: object

serializedName

serializedName: string = "properties.inboundNatPools"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "InboundNatPool"

name

name: "Composite" = "Composite"

inboundNatRules

inboundNatRules: object

serializedName

serializedName: string = "properties.inboundNatRules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "InboundNatRule"

name

name: "Composite" = "Composite"

loadBalancingRules

loadBalancingRules: object

serializedName

serializedName: string = "properties.loadBalancingRules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LoadBalancingRule"

name

name: "Composite" = "Composite"

outboundRules

outboundRules: object

serializedName

serializedName: string = "properties.outboundRules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "OutboundRule"

name

name: "Composite" = "Composite"

probes

probes: object

serializedName

serializedName: string = "properties.probes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Probe"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

resourceGuid

resourceGuid: object

serializedName

serializedName: string = "properties.resourceGuid"

type

type: object

name

name: "String" = "String"

sku

sku: object

serializedName

serializedName: string = "sku"

type

type: object

className

className: string = "LoadBalancerSku"

name

name: "Composite" = "Composite"

Const LoadBalancerBackendAddressPoolListResult

LoadBalancerBackendAddressPoolListResult: object
interface

Response for ListBackendAddressPool API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "LoadBalancerBackendAddressPoolListResult"

__@iterator

  • __@iterator(): IterableIterator<BackendAddressPool>
  • Iterator

    Returns IterableIterator<BackendAddressPool>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<BackendAddressPool>[]): BackendAddressPool[]
  • concat(...items: (T | ConcatArray<T>)[]): BackendAddressPool[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<BackendAddressPool>[]

      Additional items to add to the end of array1.

    Returns BackendAddressPool[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns BackendAddressPool[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, BackendAddressPool]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, BackendAddressPool]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: BackendAddressPool, index: number, array: BackendAddressPool[]): boolean
        • Parameters

          • value: BackendAddressPool
          • index: number
          • array: BackendAddressPool[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: BackendAddressPool, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: BackendAddressPool

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): BackendAddressPool[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: BackendAddressPool

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: BackendAddressPool, index: number, array: BackendAddressPool[]): boolean
        • Parameters

          • value: BackendAddressPool
          • index: number
          • array: BackendAddressPool[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: BackendAddressPool, index: number, array: BackendAddressPool[]): any
        • Parameters

          • value: BackendAddressPool
          • index: number
          • array: BackendAddressPool[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns BackendAddressPool[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): BackendAddressPool | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: BackendAddressPool

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: BackendAddressPool, index: number, obj: BackendAddressPool[]): boolean
        • Parameters

          • this: void
          • value: BackendAddressPool
          • index: number
          • obj: BackendAddressPool[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: BackendAddressPool, index: number, obj: BackendAddressPool[]): boolean
        • Parameters

          • value: BackendAddressPool
          • index: number
          • obj: BackendAddressPool[]

          Returns boolean

    • Optional thisArg: any

    Returns BackendAddressPool | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: BackendAddressPool, index: number, obj: BackendAddressPool[]): boolean
        • Parameters

          • value: BackendAddressPool
          • index: number
          • obj: BackendAddressPool[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: BackendAddressPool, index: number, array: BackendAddressPool[]): void
        • Parameters

          • value: BackendAddressPool
          • index: number
          • array: BackendAddressPool[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: BackendAddressPool, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: BackendAddressPool

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: BackendAddressPool, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: BackendAddressPool

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: BackendAddressPool, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: BackendAddressPool

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: BackendAddressPool, index: number, array: BackendAddressPool[]): U
        • Parameters

          • value: BackendAddressPool
          • index: number
          • array: BackendAddressPool[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): BackendAddressPool | undefined
  • Removes the last element from an array and returns it.

    Returns BackendAddressPool | undefined

push

  • push(...items: BackendAddressPool[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: BackendAddressPool[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): BackendAddressPool
  • reduce(callbackfn: function, initialValue: BackendAddressPool): BackendAddressPool
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: BackendAddressPool, currentValue: BackendAddressPool, currentIndex: number, array: BackendAddressPool[]): BackendAddressPool
        • Parameters

          • previousValue: BackendAddressPool
          • currentValue: BackendAddressPool
          • currentIndex: number
          • array: BackendAddressPool[]

          Returns BackendAddressPool

    Returns BackendAddressPool

  • Parameters

    • callbackfn: function
        • (previousValue: BackendAddressPool, currentValue: BackendAddressPool, currentIndex: number, array: BackendAddressPool[]): BackendAddressPool
        • Parameters

          • previousValue: BackendAddressPool
          • currentValue: BackendAddressPool
          • currentIndex: number
          • array: BackendAddressPool[]

          Returns BackendAddressPool

    • initialValue: BackendAddressPool

    Returns BackendAddressPool

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: BackendAddressPool, currentIndex: number, array: BackendAddressPool[]): U
        • Parameters

          • previousValue: U
          • currentValue: BackendAddressPool
          • currentIndex: number
          • array: BackendAddressPool[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): BackendAddressPool
  • reduceRight(callbackfn: function, initialValue: BackendAddressPool): BackendAddressPool
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: BackendAddressPool, currentValue: BackendAddressPool, currentIndex: number, array: BackendAddressPool[]): BackendAddressPool
        • Parameters

          • previousValue: BackendAddressPool
          • currentValue: BackendAddressPool
          • currentIndex: number
          • array: BackendAddressPool[]

          Returns BackendAddressPool

    Returns BackendAddressPool

  • Parameters

    • callbackfn: function
        • (previousValue: BackendAddressPool, currentValue: BackendAddressPool, currentIndex: number, array: BackendAddressPool[]): BackendAddressPool
        • Parameters

          • previousValue: BackendAddressPool
          • currentValue: BackendAddressPool
          • currentIndex: number
          • array: BackendAddressPool[]

          Returns BackendAddressPool

    • initialValue: BackendAddressPool

    Returns BackendAddressPool

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: BackendAddressPool, currentIndex: number, array: BackendAddressPool[]): U
        • Parameters

          • previousValue: U
          • currentValue: BackendAddressPool
          • currentIndex: number
          • array: BackendAddressPool[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): BackendAddressPool[]
  • Reverses the elements in an Array.

    Returns BackendAddressPool[]

shift

  • shift(): BackendAddressPool | undefined
  • Removes the first element from an array and returns it.

    Returns BackendAddressPool | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): BackendAddressPool[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns BackendAddressPool[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: BackendAddressPool, index: number, array: BackendAddressPool[]): boolean
        • Parameters

          • value: BackendAddressPool
          • index: number
          • array: BackendAddressPool[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): BackendAddressPool[]
  • splice(start: number, deleteCount: number, ...items: BackendAddressPool[]): BackendAddressPool[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns BackendAddressPool[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: BackendAddressPool[]

      Elements to insert into the array in place of the deleted elements.

    Returns BackendAddressPool[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: BackendAddressPool[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: BackendAddressPool[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<BackendAddressPool>
  • Returns an iterable of values in the array

    Returns IterableIterator<BackendAddressPool>

type

type: object

className

className: string = "LoadBalancerBackendAddressPoolListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "BackendAddressPool"

name

name: "Composite" = "Composite"

Const LoadBalancerFrontendIPConfigurationListResult

LoadBalancerFrontendIPConfigurationListResult: object
interface

Response for ListFrontendIPConfiguration API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "LoadBalancerFrontendIPConfigurationListResult"

__@iterator

  • __@iterator(): IterableIterator<FrontendIPConfiguration>
  • Iterator

    Returns IterableIterator<FrontendIPConfiguration>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<FrontendIPConfiguration>[]): FrontendIPConfiguration[]
  • concat(...items: (T | ConcatArray<T>)[]): FrontendIPConfiguration[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<FrontendIPConfiguration>[]

      Additional items to add to the end of array1.

    Returns FrontendIPConfiguration[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns FrontendIPConfiguration[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, FrontendIPConfiguration]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, FrontendIPConfiguration]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: FrontendIPConfiguration, index: number, array: FrontendIPConfiguration[]): boolean
        • Parameters

          • value: FrontendIPConfiguration
          • index: number
          • array: FrontendIPConfiguration[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: FrontendIPConfiguration, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: FrontendIPConfiguration

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): FrontendIPConfiguration[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: FrontendIPConfiguration

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: FrontendIPConfiguration, index: number, array: FrontendIPConfiguration[]): boolean
        • Parameters

          • value: FrontendIPConfiguration
          • index: number
          • array: FrontendIPConfiguration[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: FrontendIPConfiguration, index: number, array: FrontendIPConfiguration[]): any
        • Parameters

          • value: FrontendIPConfiguration
          • index: number
          • array: FrontendIPConfiguration[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns FrontendIPConfiguration[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): FrontendIPConfiguration | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: FrontendIPConfiguration

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: FrontendIPConfiguration, index: number, obj: FrontendIPConfiguration[]): boolean
        • Parameters

          • this: void
          • value: FrontendIPConfiguration
          • index: number
          • obj: FrontendIPConfiguration[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: FrontendIPConfiguration, index: number, obj: FrontendIPConfiguration[]): boolean
        • Parameters

          • value: FrontendIPConfiguration
          • index: number
          • obj: FrontendIPConfiguration[]

          Returns boolean

    • Optional thisArg: any

    Returns FrontendIPConfiguration | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: FrontendIPConfiguration, index: number, obj: FrontendIPConfiguration[]): boolean
        • Parameters

          • value: FrontendIPConfiguration
          • index: number
          • obj: FrontendIPConfiguration[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: FrontendIPConfiguration, index: number, array: FrontendIPConfiguration[]): void
        • Parameters

          • value: FrontendIPConfiguration
          • index: number
          • array: FrontendIPConfiguration[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: FrontendIPConfiguration, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: FrontendIPConfiguration

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: FrontendIPConfiguration, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: FrontendIPConfiguration

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: FrontendIPConfiguration, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: FrontendIPConfiguration

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: FrontendIPConfiguration, index: number, array: FrontendIPConfiguration[]): U
        • Parameters

          • value: FrontendIPConfiguration
          • index: number
          • array: FrontendIPConfiguration[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): FrontendIPConfiguration | undefined
  • Removes the last element from an array and returns it.

    Returns FrontendIPConfiguration | undefined

push

  • push(...items: FrontendIPConfiguration[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: FrontendIPConfiguration[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): FrontendIPConfiguration
  • reduce(callbackfn: function, initialValue: FrontendIPConfiguration): FrontendIPConfiguration
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: FrontendIPConfiguration, currentValue: FrontendIPConfiguration, currentIndex: number, array: FrontendIPConfiguration[]): FrontendIPConfiguration
        • Parameters

          • previousValue: FrontendIPConfiguration
          • currentValue: FrontendIPConfiguration
          • currentIndex: number
          • array: FrontendIPConfiguration[]

          Returns FrontendIPConfiguration

    Returns FrontendIPConfiguration

  • Parameters

    • callbackfn: function
        • (previousValue: FrontendIPConfiguration, currentValue: FrontendIPConfiguration, currentIndex: number, array: FrontendIPConfiguration[]): FrontendIPConfiguration
        • Parameters

          • previousValue: FrontendIPConfiguration
          • currentValue: FrontendIPConfiguration
          • currentIndex: number
          • array: FrontendIPConfiguration[]

          Returns FrontendIPConfiguration

    • initialValue: FrontendIPConfiguration

    Returns FrontendIPConfiguration

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: FrontendIPConfiguration, currentIndex: number, array: FrontendIPConfiguration[]): U
        • Parameters

          • previousValue: U
          • currentValue: FrontendIPConfiguration
          • currentIndex: number
          • array: FrontendIPConfiguration[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): FrontendIPConfiguration
  • reduceRight(callbackfn: function, initialValue: FrontendIPConfiguration): FrontendIPConfiguration
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: FrontendIPConfiguration, currentValue: FrontendIPConfiguration, currentIndex: number, array: FrontendIPConfiguration[]): FrontendIPConfiguration
        • Parameters

          • previousValue: FrontendIPConfiguration
          • currentValue: FrontendIPConfiguration
          • currentIndex: number
          • array: FrontendIPConfiguration[]

          Returns FrontendIPConfiguration

    Returns FrontendIPConfiguration

  • Parameters

    • callbackfn: function
        • (previousValue: FrontendIPConfiguration, currentValue: FrontendIPConfiguration, currentIndex: number, array: FrontendIPConfiguration[]): FrontendIPConfiguration
        • Parameters

          • previousValue: FrontendIPConfiguration
          • currentValue: FrontendIPConfiguration
          • currentIndex: number
          • array: FrontendIPConfiguration[]

          Returns FrontendIPConfiguration

    • initialValue: FrontendIPConfiguration

    Returns FrontendIPConfiguration

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: FrontendIPConfiguration, currentIndex: number, array: FrontendIPConfiguration[]): U
        • Parameters

          • previousValue: U
          • currentValue: FrontendIPConfiguration
          • currentIndex: number
          • array: FrontendIPConfiguration[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): FrontendIPConfiguration[]
  • Reverses the elements in an Array.

    Returns FrontendIPConfiguration[]

shift

  • shift(): FrontendIPConfiguration | undefined
  • Removes the first element from an array and returns it.

    Returns FrontendIPConfiguration | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): FrontendIPConfiguration[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns FrontendIPConfiguration[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: FrontendIPConfiguration, index: number, array: FrontendIPConfiguration[]): boolean
        • Parameters

          • value: FrontendIPConfiguration
          • index: number
          • array: FrontendIPConfiguration[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): FrontendIPConfiguration[]
  • splice(start: number, deleteCount: number, ...items: FrontendIPConfiguration[]): FrontendIPConfiguration[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns FrontendIPConfiguration[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: FrontendIPConfiguration[]

      Elements to insert into the array in place of the deleted elements.

    Returns FrontendIPConfiguration[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: FrontendIPConfiguration[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: FrontendIPConfiguration[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<FrontendIPConfiguration>
  • Returns an iterable of values in the array

    Returns IterableIterator<FrontendIPConfiguration>

type

type: object

className

className: string = "LoadBalancerFrontendIPConfigurationListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "FrontendIPConfiguration"

name

name: "Composite" = "Composite"

Const LoadBalancerListResult

LoadBalancerListResult: object
interface

Response for ListLoadBalancers API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "LoadBalancerListResult"

__@iterator

  • __@iterator(): IterableIterator<LoadBalancer>
  • Iterator

    Returns IterableIterator<LoadBalancer>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<LoadBalancer>[]): LoadBalancer[]
  • concat(...items: (T | ConcatArray<T>)[]): LoadBalancer[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<LoadBalancer>[]

      Additional items to add to the end of array1.

    Returns LoadBalancer[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns LoadBalancer[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, LoadBalancer]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, LoadBalancer]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: LoadBalancer, index: number, array: LoadBalancer[]): boolean
        • Parameters

          • value: LoadBalancer
          • index: number
          • array: LoadBalancer[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: LoadBalancer, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: LoadBalancer

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): LoadBalancer[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: LoadBalancer

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: LoadBalancer, index: number, array: LoadBalancer[]): boolean
        • Parameters

          • value: LoadBalancer
          • index: number
          • array: LoadBalancer[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: LoadBalancer, index: number, array: LoadBalancer[]): any
        • Parameters

          • value: LoadBalancer
          • index: number
          • array: LoadBalancer[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns LoadBalancer[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): LoadBalancer | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: LoadBalancer

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: LoadBalancer, index: number, obj: LoadBalancer[]): boolean
        • Parameters

          • this: void
          • value: LoadBalancer
          • index: number
          • obj: LoadBalancer[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: LoadBalancer, index: number, obj: LoadBalancer[]): boolean
        • Parameters

          • value: LoadBalancer
          • index: number
          • obj: LoadBalancer[]

          Returns boolean

    • Optional thisArg: any

    Returns LoadBalancer | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: LoadBalancer, index: number, obj: LoadBalancer[]): boolean
        • Parameters

          • value: LoadBalancer
          • index: number
          • obj: LoadBalancer[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: LoadBalancer, index: number, array: LoadBalancer[]): void
        • Parameters

          • value: LoadBalancer
          • index: number
          • array: LoadBalancer[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: LoadBalancer, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: LoadBalancer

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: LoadBalancer, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: LoadBalancer

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: LoadBalancer, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: LoadBalancer

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: LoadBalancer, index: number, array: LoadBalancer[]): U
        • Parameters

          • value: LoadBalancer
          • index: number
          • array: LoadBalancer[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): LoadBalancer | undefined
  • Removes the last element from an array and returns it.

    Returns LoadBalancer | undefined

push

  • push(...items: LoadBalancer[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: LoadBalancer[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): LoadBalancer
  • reduce(callbackfn: function, initialValue: LoadBalancer): LoadBalancer
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: LoadBalancer, currentValue: LoadBalancer, currentIndex: number, array: LoadBalancer[]): LoadBalancer
        • Parameters

          • previousValue: LoadBalancer
          • currentValue: LoadBalancer
          • currentIndex: number
          • array: LoadBalancer[]

          Returns LoadBalancer

    Returns LoadBalancer

  • Parameters

    • callbackfn: function
        • (previousValue: LoadBalancer, currentValue: LoadBalancer, currentIndex: number, array: LoadBalancer[]): LoadBalancer
        • Parameters

          • previousValue: LoadBalancer
          • currentValue: LoadBalancer
          • currentIndex: number
          • array: LoadBalancer[]

          Returns LoadBalancer

    • initialValue: LoadBalancer

    Returns LoadBalancer

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: LoadBalancer, currentIndex: number, array: LoadBalancer[]): U
        • Parameters

          • previousValue: U
          • currentValue: LoadBalancer
          • currentIndex: number
          • array: LoadBalancer[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): LoadBalancer
  • reduceRight(callbackfn: function, initialValue: LoadBalancer): LoadBalancer
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: LoadBalancer, currentValue: LoadBalancer, currentIndex: number, array: LoadBalancer[]): LoadBalancer
        • Parameters

          • previousValue: LoadBalancer
          • currentValue: LoadBalancer
          • currentIndex: number
          • array: LoadBalancer[]

          Returns LoadBalancer

    Returns LoadBalancer

  • Parameters

    • callbackfn: function
        • (previousValue: LoadBalancer, currentValue: LoadBalancer, currentIndex: number, array: LoadBalancer[]): LoadBalancer
        • Parameters

          • previousValue: LoadBalancer
          • currentValue: LoadBalancer
          • currentIndex: number
          • array: LoadBalancer[]

          Returns LoadBalancer

    • initialValue: LoadBalancer

    Returns LoadBalancer

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: LoadBalancer, currentIndex: number, array: LoadBalancer[]): U
        • Parameters

          • previousValue: U
          • currentValue: LoadBalancer
          • currentIndex: number
          • array: LoadBalancer[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): LoadBalancer[]
  • Reverses the elements in an Array.

    Returns LoadBalancer[]

shift

  • shift(): LoadBalancer | undefined
  • Removes the first element from an array and returns it.

    Returns LoadBalancer | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): LoadBalancer[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns LoadBalancer[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: LoadBalancer, index: number, array: LoadBalancer[]): boolean
        • Parameters

          • value: LoadBalancer
          • index: number
          • array: LoadBalancer[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): LoadBalancer[]
  • splice(start: number, deleteCount: number, ...items: LoadBalancer[]): LoadBalancer[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns LoadBalancer[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: LoadBalancer[]

      Elements to insert into the array in place of the deleted elements.

    Returns LoadBalancer[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: LoadBalancer[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: LoadBalancer[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<LoadBalancer>
  • Returns an iterable of values in the array

    Returns IterableIterator<LoadBalancer>

type

type: object

className

className: string = "LoadBalancerListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LoadBalancer"

name

name: "Composite" = "Composite"

Const LoadBalancerLoadBalancingRuleListResult

LoadBalancerLoadBalancingRuleListResult: object
interface

Response for ListLoadBalancingRule API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "LoadBalancerLoadBalancingRuleListResult"

__@iterator

  • __@iterator(): IterableIterator<LoadBalancingRule>
  • Iterator

    Returns IterableIterator<LoadBalancingRule>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<LoadBalancingRule>[]): LoadBalancingRule[]
  • concat(...items: (T | ConcatArray<T>)[]): LoadBalancingRule[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<LoadBalancingRule>[]

      Additional items to add to the end of array1.

    Returns LoadBalancingRule[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns LoadBalancingRule[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, LoadBalancingRule]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, LoadBalancingRule]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: LoadBalancingRule, index: number, array: LoadBalancingRule[]): boolean
        • Parameters

          • value: LoadBalancingRule
          • index: number
          • array: LoadBalancingRule[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: LoadBalancingRule, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: LoadBalancingRule

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): LoadBalancingRule[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: LoadBalancingRule

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: LoadBalancingRule, index: number, array: LoadBalancingRule[]): boolean
        • Parameters

          • value: LoadBalancingRule
          • index: number
          • array: LoadBalancingRule[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: LoadBalancingRule, index: number, array: LoadBalancingRule[]): any
        • Parameters

          • value: LoadBalancingRule
          • index: number
          • array: LoadBalancingRule[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns LoadBalancingRule[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): LoadBalancingRule | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: LoadBalancingRule

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: LoadBalancingRule, index: number, obj: LoadBalancingRule[]): boolean
        • Parameters

          • this: void
          • value: LoadBalancingRule
          • index: number
          • obj: LoadBalancingRule[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: LoadBalancingRule, index: number, obj: LoadBalancingRule[]): boolean
        • Parameters

          • value: LoadBalancingRule
          • index: number
          • obj: LoadBalancingRule[]

          Returns boolean

    • Optional thisArg: any

    Returns LoadBalancingRule | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: LoadBalancingRule, index: number, obj: LoadBalancingRule[]): boolean
        • Parameters

          • value: LoadBalancingRule
          • index: number
          • obj: LoadBalancingRule[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: LoadBalancingRule, index: number, array: LoadBalancingRule[]): void
        • Parameters

          • value: LoadBalancingRule
          • index: number
          • array: LoadBalancingRule[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: LoadBalancingRule, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: LoadBalancingRule

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: LoadBalancingRule, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: LoadBalancingRule

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: LoadBalancingRule, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: LoadBalancingRule

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: LoadBalancingRule, index: number, array: LoadBalancingRule[]): U
        • Parameters

          • value: LoadBalancingRule
          • index: number
          • array: LoadBalancingRule[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): LoadBalancingRule | undefined
  • Removes the last element from an array and returns it.

    Returns LoadBalancingRule | undefined

push

  • push(...items: LoadBalancingRule[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: LoadBalancingRule[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): LoadBalancingRule
  • reduce(callbackfn: function, initialValue: LoadBalancingRule): LoadBalancingRule
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: LoadBalancingRule, currentValue: LoadBalancingRule, currentIndex: number, array: LoadBalancingRule[]): LoadBalancingRule
        • Parameters

          • previousValue: LoadBalancingRule
          • currentValue: LoadBalancingRule
          • currentIndex: number
          • array: LoadBalancingRule[]

          Returns LoadBalancingRule

    Returns LoadBalancingRule

  • Parameters

    • callbackfn: function
        • (previousValue: LoadBalancingRule, currentValue: LoadBalancingRule, currentIndex: number, array: LoadBalancingRule[]): LoadBalancingRule
        • Parameters

          • previousValue: LoadBalancingRule
          • currentValue: LoadBalancingRule
          • currentIndex: number
          • array: LoadBalancingRule[]

          Returns LoadBalancingRule

    • initialValue: LoadBalancingRule

    Returns LoadBalancingRule

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: LoadBalancingRule, currentIndex: number, array: LoadBalancingRule[]): U
        • Parameters

          • previousValue: U
          • currentValue: LoadBalancingRule
          • currentIndex: number
          • array: LoadBalancingRule[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): LoadBalancingRule
  • reduceRight(callbackfn: function, initialValue: LoadBalancingRule): LoadBalancingRule
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: LoadBalancingRule, currentValue: LoadBalancingRule, currentIndex: number, array: LoadBalancingRule[]): LoadBalancingRule
        • Parameters

          • previousValue: LoadBalancingRule
          • currentValue: LoadBalancingRule
          • currentIndex: number
          • array: LoadBalancingRule[]

          Returns LoadBalancingRule

    Returns LoadBalancingRule

  • Parameters

    • callbackfn: function
        • (previousValue: LoadBalancingRule, currentValue: LoadBalancingRule, currentIndex: number, array: LoadBalancingRule[]): LoadBalancingRule
        • Parameters

          • previousValue: LoadBalancingRule
          • currentValue: LoadBalancingRule
          • currentIndex: number
          • array: LoadBalancingRule[]

          Returns LoadBalancingRule

    • initialValue: LoadBalancingRule

    Returns LoadBalancingRule

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: LoadBalancingRule, currentIndex: number, array: LoadBalancingRule[]): U
        • Parameters

          • previousValue: U
          • currentValue: LoadBalancingRule
          • currentIndex: number
          • array: LoadBalancingRule[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): LoadBalancingRule[]
  • Reverses the elements in an Array.

    Returns LoadBalancingRule[]

shift

  • shift(): LoadBalancingRule | undefined
  • Removes the first element from an array and returns it.

    Returns LoadBalancingRule | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): LoadBalancingRule[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns LoadBalancingRule[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: LoadBalancingRule, index: number, array: LoadBalancingRule[]): boolean
        • Parameters

          • value: LoadBalancingRule
          • index: number
          • array: LoadBalancingRule[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): LoadBalancingRule[]
  • splice(start: number, deleteCount: number, ...items: LoadBalancingRule[]): LoadBalancingRule[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns LoadBalancingRule[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: LoadBalancingRule[]

      Elements to insert into the array in place of the deleted elements.

    Returns LoadBalancingRule[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: LoadBalancingRule[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: LoadBalancingRule[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<LoadBalancingRule>
  • Returns an iterable of values in the array

    Returns IterableIterator<LoadBalancingRule>

type

type: object

className

className: string = "LoadBalancerLoadBalancingRuleListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LoadBalancingRule"

name

name: "Composite" = "Composite"

Const LoadBalancerOutboundRuleListResult

LoadBalancerOutboundRuleListResult: object
interface

Response for ListOutboundRule API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "LoadBalancerOutboundRuleListResult"

__@iterator

  • __@iterator(): IterableIterator<OutboundRule>
  • Iterator

    Returns IterableIterator<OutboundRule>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<OutboundRule>[]): OutboundRule[]
  • concat(...items: (T | ConcatArray<T>)[]): OutboundRule[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<OutboundRule>[]

      Additional items to add to the end of array1.

    Returns OutboundRule[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns OutboundRule[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, OutboundRule]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, OutboundRule]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: OutboundRule, index: number, array: OutboundRule[]): boolean
        • Parameters

          • value: OutboundRule
          • index: number
          • array: OutboundRule[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: OutboundRule, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: OutboundRule

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): OutboundRule[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: OutboundRule

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: OutboundRule, index: number, array: OutboundRule[]): boolean
        • Parameters

          • value: OutboundRule
          • index: number
          • array: OutboundRule[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: OutboundRule, index: number, array: OutboundRule[]): any
        • Parameters

          • value: OutboundRule
          • index: number
          • array: OutboundRule[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns OutboundRule[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): OutboundRule | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: OutboundRule

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: OutboundRule, index: number, obj: OutboundRule[]): boolean
        • Parameters

          • this: void
          • value: OutboundRule
          • index: number
          • obj: OutboundRule[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: OutboundRule, index: number, obj: OutboundRule[]): boolean
        • Parameters

          • value: OutboundRule
          • index: number
          • obj: OutboundRule[]

          Returns boolean

    • Optional thisArg: any

    Returns OutboundRule | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: OutboundRule, index: number, obj: OutboundRule[]): boolean
        • Parameters

          • value: OutboundRule
          • index: number
          • obj: OutboundRule[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: OutboundRule, index: number, array: OutboundRule[]): void
        • Parameters

          • value: OutboundRule
          • index: number
          • array: OutboundRule[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: OutboundRule, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: OutboundRule

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: OutboundRule, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: OutboundRule

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: OutboundRule, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: OutboundRule

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: OutboundRule, index: number, array: OutboundRule[]): U
        • Parameters

          • value: OutboundRule
          • index: number
          • array: OutboundRule[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): OutboundRule | undefined
  • Removes the last element from an array and returns it.

    Returns OutboundRule | undefined

push

  • push(...items: OutboundRule[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: OutboundRule[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): OutboundRule
  • reduce(callbackfn: function, initialValue: OutboundRule): OutboundRule
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: OutboundRule, currentValue: OutboundRule, currentIndex: number, array: OutboundRule[]): OutboundRule
        • Parameters

          • previousValue: OutboundRule
          • currentValue: OutboundRule
          • currentIndex: number
          • array: OutboundRule[]

          Returns OutboundRule

    Returns OutboundRule

  • Parameters

    • callbackfn: function
        • (previousValue: OutboundRule, currentValue: OutboundRule, currentIndex: number, array: OutboundRule[]): OutboundRule
        • Parameters

          • previousValue: OutboundRule
          • currentValue: OutboundRule
          • currentIndex: number
          • array: OutboundRule[]

          Returns OutboundRule

    • initialValue: OutboundRule

    Returns OutboundRule

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: OutboundRule, currentIndex: number, array: OutboundRule[]): U
        • Parameters

          • previousValue: U
          • currentValue: OutboundRule
          • currentIndex: number
          • array: OutboundRule[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): OutboundRule
  • reduceRight(callbackfn: function, initialValue: OutboundRule): OutboundRule
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: OutboundRule, currentValue: OutboundRule, currentIndex: number, array: OutboundRule[]): OutboundRule
        • Parameters

          • previousValue: OutboundRule
          • currentValue: OutboundRule
          • currentIndex: number
          • array: OutboundRule[]

          Returns OutboundRule

    Returns OutboundRule

  • Parameters

    • callbackfn: function
        • (previousValue: OutboundRule, currentValue: OutboundRule, currentIndex: number, array: OutboundRule[]): OutboundRule
        • Parameters

          • previousValue: OutboundRule
          • currentValue: OutboundRule
          • currentIndex: number
          • array: OutboundRule[]

          Returns OutboundRule

    • initialValue: OutboundRule

    Returns OutboundRule

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: OutboundRule, currentIndex: number, array: OutboundRule[]): U
        • Parameters

          • previousValue: U
          • currentValue: OutboundRule
          • currentIndex: number
          • array: OutboundRule[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): OutboundRule[]
  • Reverses the elements in an Array.

    Returns OutboundRule[]

shift

  • shift(): OutboundRule | undefined
  • Removes the first element from an array and returns it.

    Returns OutboundRule | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): OutboundRule[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns OutboundRule[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: OutboundRule, index: number, array: OutboundRule[]): boolean
        • Parameters

          • value: OutboundRule
          • index: number
          • array: OutboundRule[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): OutboundRule[]
  • splice(start: number, deleteCount: number, ...items: OutboundRule[]): OutboundRule[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns OutboundRule[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: OutboundRule[]

      Elements to insert into the array in place of the deleted elements.

    Returns OutboundRule[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: OutboundRule[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: OutboundRule[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<OutboundRule>
  • Returns an iterable of values in the array

    Returns IterableIterator<OutboundRule>

type

type: object

className

className: string = "LoadBalancerOutboundRuleListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "OutboundRule"

name

name: "Composite" = "Composite"

Const LoadBalancerProbeListResult

LoadBalancerProbeListResult: object
interface

Response for ListProbe API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "LoadBalancerProbeListResult"

__@iterator

  • __@iterator(): IterableIterator<Probe>
  • Iterator

    Returns IterableIterator<Probe>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Probe>[]): Probe[]
  • concat(...items: (T | ConcatArray<T>)[]): Probe[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Probe>[]

      Additional items to add to the end of array1.

    Returns Probe[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Probe[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Probe]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Probe]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: Probe, index: number, array: Probe[]): boolean
        • Parameters

          • value: Probe
          • index: number
          • array: Probe[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Probe, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Probe

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Probe[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: Probe

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Probe, index: number, array: Probe[]): boolean
        • Parameters

          • value: Probe
          • index: number
          • array: Probe[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Probe, index: number, array: Probe[]): any
        • Parameters

          • value: Probe
          • index: number
          • array: Probe[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Probe[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Probe | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: Probe

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Probe, index: number, obj: Probe[]): boolean
        • Parameters

          • this: void
          • value: Probe
          • index: number
          • obj: Probe[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: Probe, index: number, obj: Probe[]): boolean
        • Parameters

          • value: Probe
          • index: number
          • obj: Probe[]

          Returns boolean

    • Optional thisArg: any

    Returns Probe | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: Probe, index: number, obj: Probe[]): boolean
        • Parameters

          • value: Probe
          • index: number
          • obj: Probe[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: Probe, index: number, array: Probe[]): void
        • Parameters

          • value: Probe
          • index: number
          • array: Probe[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Probe, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Probe

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Probe, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Probe

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Probe, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Probe

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: Probe, index: number, array: Probe[]): U
        • Parameters

          • value: Probe
          • index: number
          • array: Probe[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): Probe | undefined
  • Removes the last element from an array and returns it.

    Returns Probe | undefined

push

  • push(...items: Probe[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Probe[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Probe
  • reduce(callbackfn: function, initialValue: Probe): Probe
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: Probe, currentValue: Probe, currentIndex: number, array: Probe[]): Probe
        • Parameters

          • previousValue: Probe
          • currentValue: Probe
          • currentIndex: number
          • array: Probe[]

          Returns Probe

    Returns Probe

  • Parameters

    • callbackfn: function
        • (previousValue: Probe, currentValue: Probe, currentIndex: number, array: Probe[]): Probe
        • Parameters

          • previousValue: Probe
          • currentValue: Probe
          • currentIndex: number
          • array: Probe[]

          Returns Probe

    • initialValue: Probe

    Returns Probe

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Probe, currentIndex: number, array: Probe[]): U
        • Parameters

          • previousValue: U
          • currentValue: Probe
          • currentIndex: number
          • array: Probe[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Probe
  • reduceRight(callbackfn: function, initialValue: Probe): Probe
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: Probe, currentValue: Probe, currentIndex: number, array: Probe[]): Probe
        • Parameters

          • previousValue: Probe
          • currentValue: Probe
          • currentIndex: number
          • array: Probe[]

          Returns Probe

    Returns Probe

  • Parameters

    • callbackfn: function
        • (previousValue: Probe, currentValue: Probe, currentIndex: number, array: Probe[]): Probe
        • Parameters

          • previousValue: Probe
          • currentValue: Probe
          • currentIndex: number
          • array: Probe[]

          Returns Probe

    • initialValue: Probe

    Returns Probe

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Probe, currentIndex: number, array: Probe[]): U
        • Parameters

          • previousValue: U
          • currentValue: Probe
          • currentIndex: number
          • array: Probe[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): Probe[]
  • Reverses the elements in an Array.

    Returns Probe[]

shift

  • shift(): Probe | undefined
  • Removes the first element from an array and returns it.

    Returns Probe | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Probe[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Probe[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: Probe, index: number, array: Probe[]): boolean
        • Parameters

          • value: Probe
          • index: number
          • array: Probe[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Probe[]
  • splice(start: number, deleteCount: number, ...items: Probe[]): Probe[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Probe[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Probe[]

      Elements to insert into the array in place of the deleted elements.

    Returns Probe[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Probe[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Probe[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Probe>
  • Returns an iterable of values in the array

    Returns IterableIterator<Probe>

type

type: object

className

className: string = "LoadBalancerProbeListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Probe"

name

name: "Composite" = "Composite"

Const LoadBalancerSku

LoadBalancerSku: object

SKU of a load balancer.

Optional name

Name of a load balancer SKU. Possible values include: 'Basic', 'Standard'

serializedName

serializedName: string = "LoadBalancerSku"

type

type: object

className

className: string = "LoadBalancerSku"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const LoadBalancingRule

LoadBalancingRule: object

A load balancing rule for a load balancer.

Optional backendAddressPool

backendAddressPool: SubResource

A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs.

Optional backendPort

backendPort: undefined | number

The port used for internal connections on the endpoint. Acceptable values are between 0 and

  1. Note that value 0 enables "Any Port".

Optional disableOutboundSnat

disableOutboundSnat: undefined | false | true

Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule.

Optional enableFloatingIP

enableFloatingIP: undefined | false | true

Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.

Optional enableTcpReset

enableTcpReset: undefined | false | true

Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional frontendIPConfiguration

frontendIPConfiguration: SubResource

A reference to frontend IP addresses.

frontendPort

frontendPort: number

The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 0 and 65534. Note that value 0 enables "Any Port".

Optional id

id: undefined | string

Resource ID.

Optional idleTimeoutInMinutes

idleTimeoutInMinutes: undefined | number

The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.

Optional loadDistribution

loadDistribution: LoadDistribution

The load distribution policy for this rule. Possible values include: 'Default', 'SourceIP', 'SourceIPProtocol'

Optional name

name: undefined | string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional probe

The reference of the load balancer probe used by the load balancing rule.

protocol

The reference to the transport protocol used by the load balancing rule. Possible values include: 'Udp', 'Tcp', 'All'

Optional provisioningState

provisioningState: undefined | string

Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

serializedName

serializedName: string = "LoadBalancingRule"

type

type: object

className

className: string = "LoadBalancingRule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backendAddressPool

backendAddressPool: object

serializedName

serializedName: string = "properties.backendAddressPool"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

backendPort

backendPort: object

serializedName

serializedName: string = "properties.backendPort"

type

type: object

name

name: "Number" = "Number"

disableOutboundSnat

disableOutboundSnat: object

serializedName

serializedName: string = "properties.disableOutboundSnat"

type

type: object

name

name: "Boolean" = "Boolean"

enableFloatingIP

enableFloatingIP: object

serializedName

serializedName: string = "properties.enableFloatingIP"

type

type: object

name

name: "Boolean" = "Boolean"

enableTcpReset

enableTcpReset: object

serializedName

serializedName: string = "properties.enableTcpReset"

type

type: object

name

name: "Boolean" = "Boolean"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

frontendIPConfiguration

frontendIPConfiguration: object

serializedName

serializedName: string = "properties.frontendIPConfiguration"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

frontendPort

frontendPort: object

required

required: true = true

serializedName

serializedName: string = "properties.frontendPort"

type

type: object

name

name: "Number" = "Number"

idleTimeoutInMinutes

idleTimeoutInMinutes: object

serializedName

serializedName: string = "properties.idleTimeoutInMinutes"

type

type: object

name

name: "Number" = "Number"

loadDistribution

loadDistribution: object

serializedName

serializedName: string = "properties.loadDistribution"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

probe

probe: object

serializedName

serializedName: string = "properties.probe"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

protocol

protocol: object

required

required: true = true

serializedName

serializedName: string = "properties.protocol"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

Const LocalNetworkGateway

LocalNetworkGateway: object

A common class for general resource information.

Optional bgpSettings

bgpSettings: BgpSettings

Local network gateway's BGP speaker settings.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional gatewayIpAddress

gatewayIpAddress: undefined | string

IP address of local network gateway.

Optional id

id: undefined | string

Resource ID.

Optional localNetworkAddressSpace

localNetworkAddressSpace: AddressSpace

Local network site address space.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the LocalNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceGuid

resourceGuid: undefined | string

The resource GUID property of the LocalNetworkGateway resource.

serializedName

serializedName: string = "LocalNetworkGateway"

Optional tags

tags: undefined | object

Resource tags.

type

type: object

className

className: string = "LocalNetworkGateway"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

bgpSettings

bgpSettings: object

serializedName

serializedName: string = "properties.bgpSettings"

type

type: object

className

className: string = "BgpSettings"

name

name: "Composite" = "Composite"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

gatewayIpAddress

gatewayIpAddress: object

serializedName

serializedName: string = "properties.gatewayIpAddress"

type

type: object

name

name: "String" = "String"

localNetworkAddressSpace

localNetworkAddressSpace: object

serializedName

serializedName: string = "properties.localNetworkAddressSpace"

type

type: object

className

className: string = "AddressSpace"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

resourceGuid

resourceGuid: object

serializedName

serializedName: string = "properties.resourceGuid"

type

type: object

name

name: "String" = "String"

Const LocalNetworkGatewayListResult

LocalNetworkGatewayListResult: object
interface

Response for ListLocalNetworkGateways API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "LocalNetworkGatewayListResult"

__@iterator

  • __@iterator(): IterableIterator<LocalNetworkGateway>
  • Iterator

    Returns IterableIterator<LocalNetworkGateway>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<LocalNetworkGateway>[]): LocalNetworkGateway[]
  • concat(...items: (T | ConcatArray<T>)[]): LocalNetworkGateway[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<LocalNetworkGateway>[]

      Additional items to add to the end of array1.

    Returns LocalNetworkGateway[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns LocalNetworkGateway[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, LocalNetworkGateway]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, LocalNetworkGateway]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: LocalNetworkGateway, index: number, array: LocalNetworkGateway[]): boolean
        • Parameters

          • value: LocalNetworkGateway
          • index: number
          • array: LocalNetworkGateway[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: LocalNetworkGateway, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: LocalNetworkGateway

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): LocalNetworkGateway[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: LocalNetworkGateway

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: LocalNetworkGateway, index: number, array: LocalNetworkGateway[]): boolean
        • Parameters

          • value: LocalNetworkGateway
          • index: number
          • array: LocalNetworkGateway[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: LocalNetworkGateway, index: number, array: LocalNetworkGateway[]): any
        • Parameters

          • value: LocalNetworkGateway
          • index: number
          • array: LocalNetworkGateway[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns LocalNetworkGateway[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): LocalNetworkGateway | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: LocalNetworkGateway

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: LocalNetworkGateway, index: number, obj: LocalNetworkGateway[]): boolean
        • Parameters

          • this: void
          • value: LocalNetworkGateway
          • index: number
          • obj: LocalNetworkGateway[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: LocalNetworkGateway, index: number, obj: LocalNetworkGateway[]): boolean
        • Parameters

          • value: LocalNetworkGateway
          • index: number
          • obj: LocalNetworkGateway[]

          Returns boolean

    • Optional thisArg: any

    Returns LocalNetworkGateway | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: LocalNetworkGateway, index: number, obj: LocalNetworkGateway[]): boolean
        • Parameters

          • value: LocalNetworkGateway
          • index: number
          • obj: LocalNetworkGateway[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: LocalNetworkGateway, index: number, array: LocalNetworkGateway[]): void
        • Parameters

          • value: LocalNetworkGateway
          • index: number
          • array: LocalNetworkGateway[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: LocalNetworkGateway, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: LocalNetworkGateway

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: LocalNetworkGateway, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: LocalNetworkGateway

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: LocalNetworkGateway, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: LocalNetworkGateway

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: LocalNetworkGateway, index: number, array: LocalNetworkGateway[]): U
        • Parameters

          • value: LocalNetworkGateway
          • index: number
          • array: LocalNetworkGateway[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): LocalNetworkGateway | undefined
  • Removes the last element from an array and returns it.

    Returns LocalNetworkGateway | undefined

push

  • push(...items: LocalNetworkGateway[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: LocalNetworkGateway[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): LocalNetworkGateway
  • reduce(callbackfn: function, initialValue: LocalNetworkGateway): LocalNetworkGateway
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: LocalNetworkGateway, currentValue: LocalNetworkGateway, currentIndex: number, array: LocalNetworkGateway[]): LocalNetworkGateway
        • Parameters

          • previousValue: LocalNetworkGateway
          • currentValue: LocalNetworkGateway
          • currentIndex: number
          • array: LocalNetworkGateway[]

          Returns LocalNetworkGateway

    Returns LocalNetworkGateway

  • Parameters

    • callbackfn: function
        • (previousValue: LocalNetworkGateway, currentValue: LocalNetworkGateway, currentIndex: number, array: LocalNetworkGateway[]): LocalNetworkGateway
        • Parameters

          • previousValue: LocalNetworkGateway
          • currentValue: LocalNetworkGateway
          • currentIndex: number
          • array: LocalNetworkGateway[]

          Returns LocalNetworkGateway

    • initialValue: LocalNetworkGateway

    Returns LocalNetworkGateway

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: LocalNetworkGateway, currentIndex: number, array: LocalNetworkGateway[]): U
        • Parameters

          • previousValue: U
          • currentValue: LocalNetworkGateway
          • currentIndex: number
          • array: LocalNetworkGateway[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): LocalNetworkGateway
  • reduceRight(callbackfn: function, initialValue: LocalNetworkGateway): LocalNetworkGateway
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: LocalNetworkGateway, currentValue: LocalNetworkGateway, currentIndex: number, array: LocalNetworkGateway[]): LocalNetworkGateway
        • Parameters

          • previousValue: LocalNetworkGateway
          • currentValue: LocalNetworkGateway
          • currentIndex: number
          • array: LocalNetworkGateway[]

          Returns LocalNetworkGateway

    Returns LocalNetworkGateway

  • Parameters

    • callbackfn: function
        • (previousValue: LocalNetworkGateway, currentValue: LocalNetworkGateway, currentIndex: number, array: LocalNetworkGateway[]): LocalNetworkGateway
        • Parameters

          • previousValue: LocalNetworkGateway
          • currentValue: LocalNetworkGateway
          • currentIndex: number
          • array: LocalNetworkGateway[]

          Returns LocalNetworkGateway

    • initialValue: LocalNetworkGateway

    Returns LocalNetworkGateway

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: LocalNetworkGateway, currentIndex: number, array: LocalNetworkGateway[]): U
        • Parameters

          • previousValue: U
          • currentValue: LocalNetworkGateway
          • currentIndex: number
          • array: LocalNetworkGateway[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): LocalNetworkGateway[]
  • Reverses the elements in an Array.

    Returns LocalNetworkGateway[]

shift

  • shift(): LocalNetworkGateway | undefined
  • Removes the first element from an array and returns it.

    Returns LocalNetworkGateway | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): LocalNetworkGateway[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns LocalNetworkGateway[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: LocalNetworkGateway, index: number, array: LocalNetworkGateway[]): boolean
        • Parameters

          • value: LocalNetworkGateway
          • index: number
          • array: LocalNetworkGateway[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): LocalNetworkGateway[]
  • splice(start: number, deleteCount: number, ...items: LocalNetworkGateway[]): LocalNetworkGateway[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns LocalNetworkGateway[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: LocalNetworkGateway[]

      Elements to insert into the array in place of the deleted elements.

    Returns LocalNetworkGateway[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: LocalNetworkGateway[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: LocalNetworkGateway[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<LocalNetworkGateway>
  • Returns an iterable of values in the array

    Returns IterableIterator<LocalNetworkGateway>

type

type: object

className

className: string = "LocalNetworkGatewayListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LocalNetworkGateway"

name

name: "Composite" = "Composite"

Const LogSpecification

LogSpecification: object

Description of logging specification.

Optional blobDuration

blobDuration: undefined | string

Duration of the blob.

Optional displayName

displayName: undefined | string

The display name of the specification.

Optional name

name: undefined | string

The name of the specification.

serializedName

serializedName: string = "LogSpecification"

type

type: object

className

className: string = "LogSpecification"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

blobDuration

blobDuration: object

serializedName

serializedName: string = "blobDuration"

type

type: object

name

name: "String" = "String"

displayName

displayName: object

serializedName

serializedName: string = "displayName"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const ManagedServiceIdentity

ManagedServiceIdentity: object

Identity for the resource.

Optional principalId

principalId: undefined | string

The principal id of the system assigned identity. This property will only be provided for a system assigned identity. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ManagedServiceIdentity"

Optional tenantId

tenantId: undefined | string

The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. NOTE: This property will not be serialized. It can only be populated by the server.

Optional userAssignedIdentities

userAssignedIdentities: undefined | object

The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

type

type: object

The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine. Possible values include: 'SystemAssigned', 'UserAssigned', 'SystemAssigned, UserAssigned', 'None'

className

className: string = "ManagedServiceIdentity"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

principalId

principalId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "principalId"

type

type: object

name

name: "String" = "String"

tenantId

tenantId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "tenantId"

type

type: object

name

name: "String" = "String"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

allowedValues

allowedValues: string[] = ["SystemAssigned","UserAssigned","SystemAssigned, UserAssigned","None"]

name

name: "Enum" = "Enum"

userAssignedIdentities

userAssignedIdentities: object

serializedName

serializedName: string = "userAssignedIdentities"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

className

className: string = "ManagedServiceIdentityUserAssignedIdentitiesValue"

name

name: "Composite" = "Composite"

Const ManagedServiceIdentityUserAssignedIdentitiesValue

ManagedServiceIdentityUserAssignedIdentitiesValue: object

An interface representing ManagedServiceIdentityUserAssignedIdentitiesValue.

Optional clientId

clientId: undefined | string

The client id of user assigned identity. NOTE: This property will not be serialized. It can only be populated by the server.

Optional principalId

principalId: undefined | string

The principal id of user assigned identity. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ManagedServiceIdentity_userAssignedIdentitiesValue"

type

type: object

className

className: string = "ManagedServiceIdentityUserAssignedIdentitiesValue"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientId

clientId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "clientId"

type

type: object

name

name: "String" = "String"

principalId

principalId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "principalId"

type

type: object

name

name: "String" = "String"

Const MatchCondition

MatchCondition: object

Define match conditions.

matchValues

matchValues: string[]

Match value.

matchVariables

matchVariables: MatchVariable[]

List of match variables.

Optional negationConditon

negationConditon: undefined | false | true

Describes if this is negate condition or not.

operator

Describes operator to be matched. Possible values include: 'IPMatch', 'Equal', 'Contains', 'LessThan', 'GreaterThan', 'LessThanOrEqual', 'GreaterThanOrEqual', 'BeginsWith', 'EndsWith', 'Regex'

serializedName

serializedName: string = "MatchCondition"

Optional transforms

List of transforms.

type

type: object

className

className: string = "MatchCondition"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

matchValues

matchValues: object

required

required: true = true

serializedName

serializedName: string = "matchValues"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

matchVariables

matchVariables: object

required

required: true = true

serializedName

serializedName: string = "matchVariables"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MatchVariable"

name

name: "Composite" = "Composite"

negationConditon

negationConditon: object

serializedName

serializedName: string = "negationConditon"

type

type: object

name

name: "Boolean" = "Boolean"

operator

operator: object

required

required: true = true

serializedName

serializedName: string = "operator"

type

type: object

name

name: "String" = "String"

transforms

transforms: object

serializedName

serializedName: string = "transforms"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const MatchVariable

MatchVariable: object

Define match variables.

Optional selector

selector: undefined | string

Describes field of the matchVariable collection.

serializedName

serializedName: string = "MatchVariable"

variableName

Match Variable. Possible values include: 'RemoteAddr', 'RequestMethod', 'QueryString', 'PostArgs', 'RequestUri', 'RequestHeaders', 'RequestBody', 'RequestCookies'

type

type: object

className

className: string = "MatchVariable"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

selector

selector: object

serializedName

serializedName: string = "selector"

type

type: object

name

name: "String" = "String"

variableName

variableName: object

required

required: true = true

serializedName

serializedName: string = "variableName"

type

type: object

name

name: "String" = "String"

Const MatchedRule

MatchedRule: object

Matched rule.

Optional action

action: undefined | string

The network traffic is allowed or denied. Possible values are 'Allow' and 'Deny'.

Optional ruleName

ruleName: undefined | string

Name of the matched network security rule.

serializedName

serializedName: string = "MatchedRule"

type

type: object

className

className: string = "MatchedRule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

action

action: object

serializedName

serializedName: string = "action"

type

type: object

name

name: "String" = "String"

ruleName

ruleName: object

serializedName

serializedName: string = "ruleName"

type

type: object

name

name: "String" = "String"

Const MetricSpecification

MetricSpecification: object

Description of metrics specification.

Optional aggregationType

aggregationType: undefined | string

The aggregation type.

Optional availabilities

availabilities: Availability[]

List of availability.

Optional dimensions

dimensions: Dimension[]

List of dimensions.

Optional displayDescription

displayDescription: undefined | string

The description of the metric.

Optional displayName

displayName: undefined | string

The display name of the metric.

Optional enableRegionalMdmAccount

enableRegionalMdmAccount: undefined | false | true

Whether regional MDM account enabled.

Optional fillGapWithZero

fillGapWithZero: undefined | false | true

Whether gaps would be filled with zeros.

Optional isInternal

isInternal: undefined | false | true

Whether the metric is internal.

Optional metricFilterPattern

metricFilterPattern: undefined | string

Pattern for the filter of the metric.

Optional name

name: undefined | string

The name of the metric.

Optional resourceIdDimensionNameOverride

resourceIdDimensionNameOverride: undefined | string

The resource Id dimension name override.

serializedName

serializedName: string = "MetricSpecification"

Optional sourceMdmAccount

sourceMdmAccount: undefined | string

The source MDM account.

Optional sourceMdmNamespace

sourceMdmNamespace: undefined | string

The source MDM namespace.

Optional unit

unit: undefined | string

Units the metric to be displayed in.

type

type: object

className

className: string = "MetricSpecification"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

aggregationType

aggregationType: object

serializedName

serializedName: string = "aggregationType"

type

type: object

name

name: "String" = "String"

availabilities

availabilities: object

serializedName

serializedName: string = "availabilities"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Availability"

name

name: "Composite" = "Composite"

dimensions

dimensions: object

serializedName

serializedName: string = "dimensions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Dimension"

name

name: "Composite" = "Composite"

displayDescription

displayDescription: object

serializedName

serializedName: string = "displayDescription"

type

type: object

name

name: "String" = "String"

displayName

displayName: object

serializedName

serializedName: string = "displayName"

type

type: object

name

name: "String" = "String"

enableRegionalMdmAccount

enableRegionalMdmAccount: object

serializedName

serializedName: string = "enableRegionalMdmAccount"

type

type: object

name

name: "Boolean" = "Boolean"

fillGapWithZero

fillGapWithZero: object

serializedName

serializedName: string = "fillGapWithZero"

type

type: object

name

name: "Boolean" = "Boolean"

isInternal

isInternal: object

serializedName

serializedName: string = "isInternal"

type

type: object

name

name: "Boolean" = "Boolean"

metricFilterPattern

metricFilterPattern: object

serializedName

serializedName: string = "metricFilterPattern"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

resourceIdDimensionNameOverride

resourceIdDimensionNameOverride: object

serializedName

serializedName: string = "resourceIdDimensionNameOverride"

type

type: object

name

name: "String" = "String"

sourceMdmAccount

sourceMdmAccount: object

serializedName

serializedName: string = "sourceMdmAccount"

type

type: object

name

name: "String" = "String"

sourceMdmNamespace

sourceMdmNamespace: object

serializedName

serializedName: string = "sourceMdmNamespace"

type

type: object

name

name: "String" = "String"

unit

unit: object

serializedName

serializedName: string = "unit"

type

type: object

name

name: "String" = "String"

Const NatGateway

NatGateway: object

Nat Gateway resource.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional idleTimeoutInMinutes

idleTimeoutInMinutes: undefined | number

The idle timeout of the nat gateway.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the NatGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

Optional publicIpAddresses

publicIpAddresses: SubResource[]

An array of public ip addresses associated with the nat gateway resource.

Optional publicIpPrefixes

publicIpPrefixes: SubResource[]

An array of public ip prefixes associated with the nat gateway resource.

Optional resourceGuid

resourceGuid: undefined | string

The resource GUID property of the nat gateway resource.

serializedName

serializedName: string = "NatGateway"

Optional sku

The nat gateway SKU.

Optional subnets

subnets: SubResource[]

An array of references to the subnets using this nat gateway resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object

Resource tags.

Optional zones

zones: string[]

A list of availability zones denoting the zone in which Nat Gateway should be deployed.

type

type: object

className

className: string = "NatGateway"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

idleTimeoutInMinutes

idleTimeoutInMinutes: object

serializedName

serializedName: string = "properties.idleTimeoutInMinutes"

type

type: object

name

name: "Number" = "Number"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

publicIpAddresses

publicIpAddresses: object

serializedName

serializedName: string = "properties.publicIpAddresses"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

publicIpPrefixes

publicIpPrefixes: object

serializedName

serializedName: string = "properties.publicIpPrefixes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

resourceGuid

resourceGuid: object

serializedName

serializedName: string = "properties.resourceGuid"

type

type: object

name

name: "String" = "String"

sku

sku: object

serializedName

serializedName: string = "sku"

type

type: object

className

className: string = "NatGatewaySku"

name

name: "Composite" = "Composite"

subnets

subnets: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.subnets"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

zones

zones: object

serializedName

serializedName: string = "zones"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const NatGatewayListResult

NatGatewayListResult: object
interface

Response for ListNatGateways API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "NatGatewayListResult"

__@iterator

  • __@iterator(): IterableIterator<NatGateway>
  • Iterator

    Returns IterableIterator<NatGateway>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<NatGateway>[]): NatGateway[]
  • concat(...items: (T | ConcatArray<T>)[]): NatGateway[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<NatGateway>[]

      Additional items to add to the end of array1.

    Returns NatGateway[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns NatGateway[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, NatGateway]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, NatGateway]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: NatGateway, index: number, array: NatGateway[]): boolean
        • Parameters

          • value: NatGateway
          • index: number
          • array: NatGateway[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: NatGateway, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: NatGateway

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): NatGateway[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: NatGateway

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: NatGateway, index: number, array: NatGateway[]): boolean
        • Parameters

          • value: NatGateway
          • index: number
          • array: NatGateway[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: NatGateway, index: number, array: NatGateway[]): any
        • Parameters

          • value: NatGateway
          • index: number
          • array: NatGateway[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns NatGateway[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): NatGateway | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: NatGateway

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: NatGateway, index: number, obj: NatGateway[]): boolean
        • Parameters

          • this: void
          • value: NatGateway
          • index: number
          • obj: NatGateway[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: NatGateway, index: number, obj: NatGateway[]): boolean
        • Parameters

          • value: NatGateway
          • index: number
          • obj: NatGateway[]

          Returns boolean

    • Optional thisArg: any

    Returns NatGateway | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: NatGateway, index: number, obj: NatGateway[]): boolean
        • Parameters

          • value: NatGateway
          • index: number
          • obj: NatGateway[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: NatGateway, index: number, array: NatGateway[]): void
        • Parameters

          • value: NatGateway
          • index: number
          • array: NatGateway[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: NatGateway, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: NatGateway

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: NatGateway, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: NatGateway

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: NatGateway, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: NatGateway

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: NatGateway, index: number, array: NatGateway[]): U
        • Parameters

          • value: NatGateway
          • index: number
          • array: NatGateway[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): NatGateway | undefined
  • Removes the last element from an array and returns it.

    Returns NatGateway | undefined

push

  • push(...items: NatGateway[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: NatGateway[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): NatGateway
  • reduce(callbackfn: function, initialValue: NatGateway): NatGateway
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: NatGateway, currentValue: NatGateway, currentIndex: number, array: NatGateway[]): NatGateway
        • Parameters

          • previousValue: NatGateway
          • currentValue: NatGateway
          • currentIndex: number
          • array: NatGateway[]

          Returns NatGateway

    Returns NatGateway

  • Parameters

    • callbackfn: function
        • (previousValue: NatGateway, currentValue: NatGateway, currentIndex: number, array: NatGateway[]): NatGateway
        • Parameters

          • previousValue: NatGateway
          • currentValue: NatGateway
          • currentIndex: number
          • array: NatGateway[]

          Returns NatGateway

    • initialValue: NatGateway

    Returns NatGateway

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: NatGateway, currentIndex: number, array: NatGateway[]): U
        • Parameters

          • previousValue: U
          • currentValue: NatGateway
          • currentIndex: number
          • array: NatGateway[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): NatGateway
  • reduceRight(callbackfn: function, initialValue: NatGateway): NatGateway
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: NatGateway, currentValue: NatGateway, currentIndex: number, array: NatGateway[]): NatGateway
        • Parameters

          • previousValue: NatGateway
          • currentValue: NatGateway
          • currentIndex: number
          • array: NatGateway[]

          Returns NatGateway

    Returns NatGateway

  • Parameters

    • callbackfn: function
        • (previousValue: NatGateway, currentValue: NatGateway, currentIndex: number, array: NatGateway[]): NatGateway
        • Parameters

          • previousValue: NatGateway
          • currentValue: NatGateway
          • currentIndex: number
          • array: NatGateway[]

          Returns NatGateway

    • initialValue: NatGateway

    Returns NatGateway

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: NatGateway, currentIndex: number, array: NatGateway[]): U
        • Parameters

          • previousValue: U
          • currentValue: NatGateway
          • currentIndex: number
          • array: NatGateway[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): NatGateway[]
  • Reverses the elements in an Array.

    Returns NatGateway[]

shift

  • shift(): NatGateway | undefined
  • Removes the first element from an array and returns it.

    Returns NatGateway | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): NatGateway[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns NatGateway[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: NatGateway, index: number, array: NatGateway[]): boolean
        • Parameters

          • value: NatGateway
          • index: number
          • array: NatGateway[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): NatGateway[]
  • splice(start: number, deleteCount: number, ...items: NatGateway[]): NatGateway[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns NatGateway[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: NatGateway[]

      Elements to insert into the array in place of the deleted elements.

    Returns NatGateway[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: NatGateway[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: NatGateway[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<NatGateway>
  • Returns an iterable of values in the array

    Returns IterableIterator<NatGateway>

type

type: object

className

className: string = "NatGatewayListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NatGateway"

name

name: "Composite" = "Composite"

Const NatGatewaySku

NatGatewaySku: object

SKU of nat gateway.

Optional name

Name of Nat Gateway SKU. Possible values include: 'Standard'

serializedName

serializedName: string = "NatGatewaySku"

type

type: object

className

className: string = "NatGatewaySku"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const NetworkConfigurationDiagnosticParameters

NetworkConfigurationDiagnosticParameters: object

Parameters to get network configuration diagnostic.

profiles

profiles: NetworkConfigurationDiagnosticProfile[]

List of network configuration diagnostic profiles.

serializedName

serializedName: string = "NetworkConfigurationDiagnosticParameters"

targetResourceId

targetResourceId: string

The ID of the target resource to perform network configuration diagnostic. Valid options are VM, NetworkInterface, VMSS/NetworkInterface and Application Gateway.

Optional verbosityLevel

verbosityLevel: VerbosityLevel

Verbosity level. Possible values include: 'Normal', 'Minimum', 'Full'

type

type: object

className

className: string = "NetworkConfigurationDiagnosticParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

profiles

profiles: object

required

required: true = true

serializedName

serializedName: string = "profiles"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NetworkConfigurationDiagnosticProfile"

name

name: "Composite" = "Composite"

targetResourceId

targetResourceId: object

required

required: true = true

serializedName

serializedName: string = "targetResourceId"

type

type: object

name

name: "String" = "String"

verbosityLevel

verbosityLevel: object

serializedName

serializedName: string = "verbosityLevel"

type

type: object

name

name: "String" = "String"

Const NetworkConfigurationDiagnosticProfile

NetworkConfigurationDiagnosticProfile: object

Parameters to compare with network configuration.

destination

destination: string

Traffic destination. Accepted values are: '*', IP Address/CIDR, Service Tag.

destinationPort

destinationPort: string

Traffic destination port. Accepted values are '*', port (for example, 3389) and port range (for example, 80-100).

direction

direction: Direction

The direction of the traffic. Possible values include: 'Inbound', 'Outbound'

protocol

protocol: string

Protocol to be verified on. Accepted values are '*', TCP, UDP.

serializedName

serializedName: string = "NetworkConfigurationDiagnosticProfile"

source

source: string

Traffic source. Accepted values are '*', IP Address/CIDR, Service Tag.

type

type: object

className

className: string = "NetworkConfigurationDiagnosticProfile"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

destination

destination: object

required

required: true = true

serializedName

serializedName: string = "destination"

type

type: object

name

name: "String" = "String"

destinationPort

destinationPort: object

required

required: true = true

serializedName

serializedName: string = "destinationPort"

type

type: object

name

name: "String" = "String"

direction

direction: object

required

required: true = true

serializedName

serializedName: string = "direction"

type

type: object

name

name: "String" = "String"

protocol

protocol: object

required

required: true = true

serializedName

serializedName: string = "protocol"

type

type: object

name

name: "String" = "String"

source

source: object

required

required: true = true

serializedName

serializedName: string = "source"

type

type: object

name

name: "String" = "String"

Const NetworkConfigurationDiagnosticResponse

NetworkConfigurationDiagnosticResponse: object

Results of network configuration diagnostic on the target resource.

Optional results

results: NetworkConfigurationDiagnosticResult[]

List of network configuration diagnostic results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "NetworkConfigurationDiagnosticResponse"

type

type: object

className

className: string = "NetworkConfigurationDiagnosticResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

results

results: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "results"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NetworkConfigurationDiagnosticResult"

name

name: "Composite" = "Composite"

Const NetworkConfigurationDiagnosticResult

NetworkConfigurationDiagnosticResult: object

Network configuration diagnostic result corresponded to provided traffic query.

Optional networkSecurityGroupResult

networkSecurityGroupResult: NetworkSecurityGroupResult

Network security group result.

Optional profile

Network configuration diagnostic profile.

serializedName

serializedName: string = "NetworkConfigurationDiagnosticResult"

type

type: object

className

className: string = "NetworkConfigurationDiagnosticResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

networkSecurityGroupResult

networkSecurityGroupResult: object

serializedName

serializedName: string = "networkSecurityGroupResult"

type

type: object

className

className: string = "NetworkSecurityGroupResult"

name

name: "Composite" = "Composite"

profile

profile: object

serializedName

serializedName: string = "profile"

type

type: object

className

className: string = "NetworkConfigurationDiagnosticProfile"

name

name: "Composite" = "Composite"

Const NetworkIntentPolicy

NetworkIntentPolicy: object

Network Intent Policy resource.

Optional etag

etag: undefined | string

Gets a unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "NetworkIntentPolicy"

Optional tags

tags: undefined | object

Resource tags.

type

type: object

className

className: string = "NetworkIntentPolicy"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const NetworkIntentPolicyConfiguration

NetworkIntentPolicyConfiguration: object

Details of NetworkIntentPolicyConfiguration for PrepareNetworkPoliciesRequest.

Optional networkIntentPolicyName

networkIntentPolicyName: undefined | string

The name of the Network Intent Policy for storing in target subscription.

serializedName

serializedName: string = "NetworkIntentPolicyConfiguration"

Optional sourceNetworkIntentPolicy

sourceNetworkIntentPolicy: NetworkIntentPolicy

Source network intent policy.

type

type: object

className

className: string = "NetworkIntentPolicyConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

networkIntentPolicyName

networkIntentPolicyName: object

serializedName

serializedName: string = "networkIntentPolicyName"

type

type: object

name

name: "String" = "String"

sourceNetworkIntentPolicy

sourceNetworkIntentPolicy: object

serializedName

serializedName: string = "sourceNetworkIntentPolicy"

type

type: object

className

className: string = "NetworkIntentPolicy"

name

name: "Composite" = "Composite"

Const NetworkInterface

NetworkInterface: object

A network interface in a resource group.

Optional dnsSettings

The DNS settings in network interface.

Optional enableAcceleratedNetworking

enableAcceleratedNetworking: undefined | false | true

If the network interface is accelerated networking enabled.

Optional enableIPForwarding

enableIPForwarding: undefined | false | true

Indicates whether IP forwarding is enabled on this network interface.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional hostedWorkloads

hostedWorkloads: string[]

A list of references to linked BareMetal resources. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID.

Optional ipConfigurations

ipConfigurations: NetworkInterfaceIPConfiguration[]

A list of IPConfigurations of the network interface.

Optional location

location: undefined | string

Resource location.

Optional macAddress

macAddress: undefined | string

The MAC address of the network interface.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional networkSecurityGroup

networkSecurityGroup: NetworkSecurityGroup

The reference of the NetworkSecurityGroup resource.

Optional primary

primary: undefined | false | true

Gets whether this is a primary network interface on a virtual machine.

Optional privateEndpoint

privateEndpoint: PrivateEndpoint

A reference to the private endpoint to which the network interface is linked. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

Optional resourceGuid

resourceGuid: undefined | string

The resource GUID property of the network interface resource.

serializedName

serializedName: string = "NetworkInterface"

Optional tags

tags: undefined | object

Resource tags.

Optional tapConfigurations

tapConfigurations: NetworkInterfaceTapConfiguration[]

A list of TapConfigurations of the network interface.

Optional virtualMachine

virtualMachine: SubResource

The reference of a virtual machine. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "NetworkInterface"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dnsSettings

dnsSettings: object

serializedName

serializedName: string = "properties.dnsSettings"

type

type: object

className

className: string = "NetworkInterfaceDnsSettings"

name

name: "Composite" = "Composite"

enableAcceleratedNetworking

enableAcceleratedNetworking: object

serializedName

serializedName: string = "properties.enableAcceleratedNetworking"

type

type: object

name

name: "Boolean" = "Boolean"

enableIPForwarding

enableIPForwarding: object

serializedName

serializedName: string = "properties.enableIPForwarding"

type

type: object

name

name: "Boolean" = "Boolean"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

hostedWorkloads

hostedWorkloads: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.hostedWorkloads"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

ipConfigurations

ipConfigurations: object

serializedName

serializedName: string = "properties.ipConfigurations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NetworkInterfaceIPConfiguration"

name

name: "Composite" = "Composite"

macAddress

macAddress: object

serializedName

serializedName: string = "properties.macAddress"

type

type: object

name

name: "String" = "String"

networkSecurityGroup

networkSecurityGroup: object

serializedName

serializedName: string = "properties.networkSecurityGroup"

type

type: object

className

className: string = "NetworkSecurityGroup"

name

name: "Composite" = "Composite"

primary

primary: object

serializedName

serializedName: string = "properties.primary"

type

type: object

name

name: "Boolean" = "Boolean"

privateEndpoint

privateEndpoint: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.privateEndpoint"

type

type: object

className

className: string = "PrivateEndpoint"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

resourceGuid

resourceGuid: object

serializedName

serializedName: string = "properties.resourceGuid"

type

type: object

name

name: "String" = "String"

tapConfigurations

tapConfigurations: object

serializedName

serializedName: string = "properties.tapConfigurations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NetworkInterfaceTapConfiguration"

name

name: "Composite" = "Composite"

virtualMachine

virtualMachine: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.virtualMachine"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

Const NetworkInterfaceAssociation

NetworkInterfaceAssociation: object

Network interface and its custom security rules.

Optional id

id: undefined | string

Network interface ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional securityRules

securityRules: SecurityRule[]

Collection of custom security rules.

serializedName

serializedName: string = "NetworkInterfaceAssociation"

type

type: object

className

className: string = "NetworkInterfaceAssociation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

securityRules

securityRules: object

serializedName

serializedName: string = "securityRules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SecurityRule"

name

name: "Composite" = "Composite"

Const NetworkInterfaceDnsSettings

NetworkInterfaceDnsSettings: object

DNS settings of a network interface.

Optional appliedDnsServers

appliedDnsServers: string[]

If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs.

Optional dnsServers

dnsServers: string[]

List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection.

Optional internalDnsNameLabel

internalDnsNameLabel: undefined | string

Relative DNS name for this NIC used for internal communications between VMs in the same virtual network.

Optional internalDomainNameSuffix

internalDomainNameSuffix: undefined | string

Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internalDomainNameSuffix.

Optional internalFqdn

internalFqdn: undefined | string

Fully qualified DNS name supporting internal communications between VMs in the same virtual network.

serializedName

serializedName: string = "NetworkInterfaceDnsSettings"

type

type: object

className

className: string = "NetworkInterfaceDnsSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

appliedDnsServers

appliedDnsServers: object

serializedName

serializedName: string = "appliedDnsServers"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

dnsServers

dnsServers: object

serializedName

serializedName: string = "dnsServers"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

internalDnsNameLabel

internalDnsNameLabel: object

serializedName

serializedName: string = "internalDnsNameLabel"

type

type: object

name

name: "String" = "String"

internalDomainNameSuffix

internalDomainNameSuffix: object

serializedName

serializedName: string = "internalDomainNameSuffix"

type

type: object

name

name: "String" = "String"

internalFqdn

internalFqdn: object

serializedName

serializedName: string = "internalFqdn"

type

type: object

name

name: "String" = "String"

Const NetworkInterfaceIPConfiguration

NetworkInterfaceIPConfiguration: object

IPConfiguration in a network interface.

Optional applicationGatewayBackendAddressPools

applicationGatewayBackendAddressPools: ApplicationGatewayBackendAddressPool[]

The reference of ApplicationGatewayBackendAddressPool resource.

Optional applicationSecurityGroups

applicationSecurityGroups: ApplicationSecurityGroup[]

Application security groups in which the IP configuration is included.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional loadBalancerBackendAddressPools

loadBalancerBackendAddressPools: BackendAddressPool[]

The reference of LoadBalancerBackendAddressPool resource.

Optional loadBalancerInboundNatRules

loadBalancerInboundNatRules: InboundNatRule[]

A list of references of LoadBalancerInboundNatRules.

Optional name

name: undefined | string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional primary

primary: undefined | false | true

Gets whether this is a primary customer address on the network interface.

Optional privateIPAddress

privateIPAddress: undefined | string

Private IP address of the IP configuration.

Optional privateIPAddressVersion

privateIPAddressVersion: IPVersion

Available from Api-Version 2016-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values include: 'IPv4', 'IPv6'

Optional privateIPAllocationMethod

privateIPAllocationMethod: IPAllocationMethod

The private IP address allocation method. Possible values include: 'Static', 'Dynamic'

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'.

Optional publicIPAddress

publicIPAddress: PublicIPAddress

Public IP address bound to the IP configuration.

serializedName

serializedName: string = "NetworkInterfaceIPConfiguration"

Optional subnet

subnet: Subnet

Subnet bound to the IP configuration.

Optional virtualNetworkTaps

virtualNetworkTaps: VirtualNetworkTap[]

The reference to Virtual Network Taps.

type

type: object

className

className: string = "NetworkInterfaceIPConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicationGatewayBackendAddressPools

applicationGatewayBackendAddressPools: object

serializedName

serializedName: string = "properties.applicationGatewayBackendAddressPools"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationGatewayBackendAddressPool"

name

name: "Composite" = "Composite"

applicationSecurityGroups

applicationSecurityGroups: object

serializedName

serializedName: string = "properties.applicationSecurityGroups"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationSecurityGroup"

name

name: "Composite" = "Composite"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

loadBalancerBackendAddressPools

loadBalancerBackendAddressPools: object

serializedName

serializedName: string = "properties.loadBalancerBackendAddressPools"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "BackendAddressPool"

name

name: "Composite" = "Composite"

loadBalancerInboundNatRules

loadBalancerInboundNatRules: object

serializedName

serializedName: string = "properties.loadBalancerInboundNatRules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "InboundNatRule"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

primary

primary: object

serializedName

serializedName: string = "properties.primary"

type

type: object

name

name: "Boolean" = "Boolean"

privateIPAddress

privateIPAddress: object

serializedName

serializedName: string = "properties.privateIPAddress"

type

type: object

name

name: "String" = "String"

privateIPAddressVersion

privateIPAddressVersion: object

serializedName

serializedName: string = "properties.privateIPAddressVersion"

type

type: object

name

name: "String" = "String"

privateIPAllocationMethod

privateIPAllocationMethod: object

serializedName

serializedName: string = "properties.privateIPAllocationMethod"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

publicIPAddress

publicIPAddress: object

serializedName

serializedName: string = "properties.publicIPAddress"

type

type: object

className

className: string = "PublicIPAddress"

name

name: "Composite" = "Composite"

subnet

subnet: object

serializedName

serializedName: string = "properties.subnet"

type

type: object

className

className: string = "Subnet"

name

name: "Composite" = "Composite"

virtualNetworkTaps

virtualNetworkTaps: object

serializedName

serializedName: string = "properties.virtualNetworkTaps"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VirtualNetworkTap"

name

name: "Composite" = "Composite"

Const NetworkInterfaceIPConfigurationListResult

NetworkInterfaceIPConfigurationListResult: object
interface

Response for list ip configurations API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "NetworkInterfaceIPConfigurationListResult"

__@iterator

  • __@iterator(): IterableIterator<NetworkInterfaceIPConfiguration>
  • Iterator

    Returns IterableIterator<NetworkInterfaceIPConfiguration>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<NetworkInterfaceIPConfiguration>[]): NetworkInterfaceIPConfiguration[]
  • concat(...items: (T | ConcatArray<T>)[]): NetworkInterfaceIPConfiguration[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<NetworkInterfaceIPConfiguration>[]

      Additional items to add to the end of array1.

    Returns NetworkInterfaceIPConfiguration[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns NetworkInterfaceIPConfiguration[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, NetworkInterfaceIPConfiguration]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, NetworkInterfaceIPConfiguration]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: NetworkInterfaceIPConfiguration, index: number, array: NetworkInterfaceIPConfiguration[]): boolean
        • Parameters

          • value: NetworkInterfaceIPConfiguration
          • index: number
          • array: NetworkInterfaceIPConfiguration[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: NetworkInterfaceIPConfiguration, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: NetworkInterfaceIPConfiguration

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): NetworkInterfaceIPConfiguration[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: NetworkInterfaceIPConfiguration

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: NetworkInterfaceIPConfiguration, index: number, array: NetworkInterfaceIPConfiguration[]): boolean
        • Parameters

          • value: NetworkInterfaceIPConfiguration
          • index: number
          • array: NetworkInterfaceIPConfiguration[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: NetworkInterfaceIPConfiguration, index: number, array: NetworkInterfaceIPConfiguration[]): any
        • Parameters

          • value: NetworkInterfaceIPConfiguration
          • index: number
          • array: NetworkInterfaceIPConfiguration[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns NetworkInterfaceIPConfiguration[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): NetworkInterfaceIPConfiguration | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: NetworkInterfaceIPConfiguration

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: NetworkInterfaceIPConfiguration, index: number, obj: NetworkInterfaceIPConfiguration[]): boolean
        • Parameters

          • this: void
          • value: NetworkInterfaceIPConfiguration
          • index: number
          • obj: NetworkInterfaceIPConfiguration[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: NetworkInterfaceIPConfiguration, index: number, obj: NetworkInterfaceIPConfiguration[]): boolean
        • Parameters

          • value: NetworkInterfaceIPConfiguration
          • index: number
          • obj: NetworkInterfaceIPConfiguration[]

          Returns boolean

    • Optional thisArg: any

    Returns NetworkInterfaceIPConfiguration | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: NetworkInterfaceIPConfiguration, index: number, obj: NetworkInterfaceIPConfiguration[]): boolean
        • Parameters

          • value: NetworkInterfaceIPConfiguration
          • index: number
          • obj: NetworkInterfaceIPConfiguration[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: NetworkInterfaceIPConfiguration, index: number, array: NetworkInterfaceIPConfiguration[]): void
        • Parameters

          • value: NetworkInterfaceIPConfiguration
          • index: number
          • array: NetworkInterfaceIPConfiguration[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: NetworkInterfaceIPConfiguration, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: NetworkInterfaceIPConfiguration

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: NetworkInterfaceIPConfiguration, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: NetworkInterfaceIPConfiguration

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: NetworkInterfaceIPConfiguration, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: NetworkInterfaceIPConfiguration

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: NetworkInterfaceIPConfiguration, index: number, array: NetworkInterfaceIPConfiguration[]): U
        • Parameters

          • value: NetworkInterfaceIPConfiguration
          • index: number
          • array: NetworkInterfaceIPConfiguration[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): NetworkInterfaceIPConfiguration | undefined
  • Removes the last element from an array and returns it.

    Returns NetworkInterfaceIPConfiguration | undefined

push

  • push(...items: NetworkInterfaceIPConfiguration[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: NetworkInterfaceIPConfiguration[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): NetworkInterfaceIPConfiguration
  • reduce(callbackfn: function, initialValue: NetworkInterfaceIPConfiguration): NetworkInterfaceIPConfiguration
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: NetworkInterfaceIPConfiguration, currentValue: NetworkInterfaceIPConfiguration, currentIndex: number, array: NetworkInterfaceIPConfiguration[]): NetworkInterfaceIPConfiguration
        • Parameters

          • previousValue: NetworkInterfaceIPConfiguration
          • currentValue: NetworkInterfaceIPConfiguration
          • currentIndex: number
          • array: NetworkInterfaceIPConfiguration[]

          Returns NetworkInterfaceIPConfiguration

    Returns NetworkInterfaceIPConfiguration

  • Parameters

    • callbackfn: function
        • (previousValue: NetworkInterfaceIPConfiguration, currentValue: NetworkInterfaceIPConfiguration, currentIndex: number, array: NetworkInterfaceIPConfiguration[]): NetworkInterfaceIPConfiguration
        • Parameters

          • previousValue: NetworkInterfaceIPConfiguration
          • currentValue: NetworkInterfaceIPConfiguration
          • currentIndex: number
          • array: NetworkInterfaceIPConfiguration[]

          Returns NetworkInterfaceIPConfiguration

    • initialValue: NetworkInterfaceIPConfiguration

    Returns NetworkInterfaceIPConfiguration

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: NetworkInterfaceIPConfiguration, currentIndex: number, array: NetworkInterfaceIPConfiguration[]): U
        • Parameters

          • previousValue: U
          • currentValue: NetworkInterfaceIPConfiguration
          • currentIndex: number
          • array: NetworkInterfaceIPConfiguration[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): NetworkInterfaceIPConfiguration
  • reduceRight(callbackfn: function, initialValue: NetworkInterfaceIPConfiguration): NetworkInterfaceIPConfiguration
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: NetworkInterfaceIPConfiguration, currentValue: NetworkInterfaceIPConfiguration, currentIndex: number, array: NetworkInterfaceIPConfiguration[]): NetworkInterfaceIPConfiguration
        • Parameters

          • previousValue: NetworkInterfaceIPConfiguration
          • currentValue: NetworkInterfaceIPConfiguration
          • currentIndex: number
          • array: NetworkInterfaceIPConfiguration[]

          Returns NetworkInterfaceIPConfiguration

    Returns NetworkInterfaceIPConfiguration

  • Parameters

    • callbackfn: function
        • (previousValue: NetworkInterfaceIPConfiguration, currentValue: NetworkInterfaceIPConfiguration, currentIndex: number, array: NetworkInterfaceIPConfiguration[]): NetworkInterfaceIPConfiguration
        • Parameters

          • previousValue: NetworkInterfaceIPConfiguration
          • currentValue: NetworkInterfaceIPConfiguration
          • currentIndex: number
          • array: NetworkInterfaceIPConfiguration[]

          Returns NetworkInterfaceIPConfiguration

    • initialValue: NetworkInterfaceIPConfiguration

    Returns NetworkInterfaceIPConfiguration

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: NetworkInterfaceIPConfiguration, currentIndex: number, array: NetworkInterfaceIPConfiguration[]): U
        • Parameters

          • previousValue: U
          • currentValue: NetworkInterfaceIPConfiguration
          • currentIndex: number
          • array: NetworkInterfaceIPConfiguration[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): NetworkInterfaceIPConfiguration[]
  • Reverses the elements in an Array.

    Returns NetworkInterfaceIPConfiguration[]

shift

  • shift(): NetworkInterfaceIPConfiguration | undefined
  • Removes the first element from an array and returns it.

    Returns NetworkInterfaceIPConfiguration | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): NetworkInterfaceIPConfiguration[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns NetworkInterfaceIPConfiguration[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: NetworkInterfaceIPConfiguration, index: number, array: NetworkInterfaceIPConfiguration[]): boolean
        • Parameters

          • value: NetworkInterfaceIPConfiguration
          • index: number
          • array: NetworkInterfaceIPConfiguration[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): NetworkInterfaceIPConfiguration[]
  • splice(start: number, deleteCount: number, ...items: NetworkInterfaceIPConfiguration[]): NetworkInterfaceIPConfiguration[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns NetworkInterfaceIPConfiguration[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: NetworkInterfaceIPConfiguration[]

      Elements to insert into the array in place of the deleted elements.

    Returns NetworkInterfaceIPConfiguration[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: NetworkInterfaceIPConfiguration[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: NetworkInterfaceIPConfiguration[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<NetworkInterfaceIPConfiguration>
  • Returns an iterable of values in the array

    Returns IterableIterator<NetworkInterfaceIPConfiguration>

type

type: object

className

className: string = "NetworkInterfaceIPConfigurationListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NetworkInterfaceIPConfiguration"

name

name: "Composite" = "Composite"

Const NetworkInterfaceListResult

NetworkInterfaceListResult: object
interface

Response for the ListNetworkInterface API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "NetworkInterfaceListResult"

__@iterator

  • __@iterator(): IterableIterator<NetworkInterface>
  • Iterator

    Returns IterableIterator<NetworkInterface>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<NetworkInterface>[]): NetworkInterface[]
  • concat(...items: (T | ConcatArray<T>)[]): NetworkInterface[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<NetworkInterface>[]

      Additional items to add to the end of array1.

    Returns NetworkInterface[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns NetworkInterface[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, NetworkInterface]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, NetworkInterface]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: NetworkInterface, index: number, array: NetworkInterface[]): boolean
        • Parameters

          • value: NetworkInterface
          • index: number
          • array: NetworkInterface[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: NetworkInterface, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: NetworkInterface

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): NetworkInterface[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: NetworkInterface

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: NetworkInterface, index: number, array: NetworkInterface[]): boolean
        • Parameters

          • value: NetworkInterface
          • index: number
          • array: NetworkInterface[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: NetworkInterface, index: number, array: NetworkInterface[]): any
        • Parameters

          • value: NetworkInterface
          • index: number
          • array: NetworkInterface[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns NetworkInterface[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): NetworkInterface | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: NetworkInterface

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: NetworkInterface, index: number, obj: NetworkInterface[]): boolean
        • Parameters

          • this: void
          • value: NetworkInterface
          • index: number
          • obj: NetworkInterface[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: NetworkInterface, index: number, obj: NetworkInterface[]): boolean
        • Parameters

          • value: NetworkInterface
          • index: number
          • obj: NetworkInterface[]

          Returns boolean

    • Optional thisArg: any

    Returns NetworkInterface | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: NetworkInterface, index: number, obj: NetworkInterface[]): boolean
        • Parameters

          • value: NetworkInterface
          • index: number
          • obj: NetworkInterface[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: NetworkInterface, index: number, array: NetworkInterface[]): void
        • Parameters

          • value: NetworkInterface
          • index: number
          • array: NetworkInterface[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: NetworkInterface, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: NetworkInterface

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: NetworkInterface, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: NetworkInterface

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: NetworkInterface, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: NetworkInterface

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: NetworkInterface, index: number, array: NetworkInterface[]): U
        • Parameters

          • value: NetworkInterface
          • index: number
          • array: NetworkInterface[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): NetworkInterface | undefined
  • Removes the last element from an array and returns it.

    Returns NetworkInterface | undefined

push

  • push(...items: NetworkInterface[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: NetworkInterface[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): NetworkInterface
  • reduce(callbackfn: function, initialValue: NetworkInterface): NetworkInterface
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: NetworkInterface, currentValue: NetworkInterface, currentIndex: number, array: NetworkInterface[]): NetworkInterface
        • Parameters

          • previousValue: NetworkInterface
          • currentValue: NetworkInterface
          • currentIndex: number
          • array: NetworkInterface[]

          Returns NetworkInterface

    Returns NetworkInterface

  • Parameters

    • callbackfn: function
        • (previousValue: NetworkInterface, currentValue: NetworkInterface, currentIndex: number, array: NetworkInterface[]): NetworkInterface
        • Parameters

          • previousValue: NetworkInterface
          • currentValue: NetworkInterface
          • currentIndex: number
          • array: NetworkInterface[]

          Returns NetworkInterface

    • initialValue: NetworkInterface

    Returns NetworkInterface

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: NetworkInterface, currentIndex: number, array: NetworkInterface[]): U
        • Parameters

          • previousValue: U
          • currentValue: NetworkInterface
          • currentIndex: number
          • array: NetworkInterface[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): NetworkInterface
  • reduceRight(callbackfn: function, initialValue: NetworkInterface): NetworkInterface
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: NetworkInterface, currentValue: NetworkInterface, currentIndex: number, array: NetworkInterface[]): NetworkInterface
        • Parameters

          • previousValue: NetworkInterface
          • currentValue: NetworkInterface
          • currentIndex: number
          • array: NetworkInterface[]

          Returns NetworkInterface

    Returns NetworkInterface

  • Parameters

    • callbackfn: function
        • (previousValue: NetworkInterface, currentValue: NetworkInterface, currentIndex: number, array: NetworkInterface[]): NetworkInterface
        • Parameters

          • previousValue: NetworkInterface
          • currentValue: NetworkInterface
          • currentIndex: number
          • array: NetworkInterface[]

          Returns NetworkInterface

    • initialValue: NetworkInterface

    Returns NetworkInterface

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: NetworkInterface, currentIndex: number, array: NetworkInterface[]): U
        • Parameters

          • previousValue: U
          • currentValue: NetworkInterface
          • currentIndex: number
          • array: NetworkInterface[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): NetworkInterface[]
  • Reverses the elements in an Array.

    Returns NetworkInterface[]

shift

  • shift(): NetworkInterface | undefined
  • Removes the first element from an array and returns it.

    Returns NetworkInterface | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): NetworkInterface[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns NetworkInterface[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: NetworkInterface, index: number, array: NetworkInterface[]): boolean
        • Parameters

          • value: NetworkInterface
          • index: number
          • array: NetworkInterface[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): NetworkInterface[]
  • splice(start: number, deleteCount: number, ...items: NetworkInterface[]): NetworkInterface[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns NetworkInterface[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: NetworkInterface[]

      Elements to insert into the array in place of the deleted elements.

    Returns NetworkInterface[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: NetworkInterface[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: NetworkInterface[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<NetworkInterface>
  • Returns an iterable of values in the array

    Returns IterableIterator<NetworkInterface>

type

type: object

className

className: string = "NetworkInterfaceListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NetworkInterface"

name

name: "Composite" = "Composite"

Const NetworkInterfaceLoadBalancerListResult

NetworkInterfaceLoadBalancerListResult: object
interface

Response for list ip configurations API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "NetworkInterfaceLoadBalancerListResult"

__@iterator

  • __@iterator(): IterableIterator<LoadBalancer>
  • Iterator

    Returns IterableIterator<LoadBalancer>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<LoadBalancer>[]): LoadBalancer[]
  • concat(...items: (T | ConcatArray<T>)[]): LoadBalancer[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<LoadBalancer>[]

      Additional items to add to the end of array1.

    Returns LoadBalancer[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns LoadBalancer[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, LoadBalancer]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, LoadBalancer]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: LoadBalancer, index: number, array: LoadBalancer[]): boolean
        • Parameters

          • value: LoadBalancer
          • index: number
          • array: LoadBalancer[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: LoadBalancer, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: LoadBalancer

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): LoadBalancer[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: LoadBalancer

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: LoadBalancer, index: number, array: LoadBalancer[]): boolean
        • Parameters

          • value: LoadBalancer
          • index: number
          • array: LoadBalancer[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: LoadBalancer, index: number, array: LoadBalancer[]): any
        • Parameters

          • value: LoadBalancer
          • index: number
          • array: LoadBalancer[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns LoadBalancer[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): LoadBalancer | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: LoadBalancer

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: LoadBalancer, index: number, obj: LoadBalancer[]): boolean
        • Parameters

          • this: void
          • value: LoadBalancer
          • index: number
          • obj: LoadBalancer[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: LoadBalancer, index: number, obj: LoadBalancer[]): boolean
        • Parameters

          • value: LoadBalancer
          • index: number
          • obj: LoadBalancer[]

          Returns boolean

    • Optional thisArg: any

    Returns LoadBalancer | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: LoadBalancer, index: number, obj: LoadBalancer[]): boolean
        • Parameters

          • value: LoadBalancer
          • index: number
          • obj: LoadBalancer[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: LoadBalancer, index: number, array: LoadBalancer[]): void
        • Parameters

          • value: LoadBalancer
          • index: number
          • array: LoadBalancer[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: LoadBalancer, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: LoadBalancer

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: LoadBalancer, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: LoadBalancer

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: LoadBalancer, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: LoadBalancer

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: LoadBalancer, index: number, array: LoadBalancer[]): U
        • Parameters

          • value: LoadBalancer
          • index: number
          • array: LoadBalancer[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): LoadBalancer | undefined
  • Removes the last element from an array and returns it.

    Returns LoadBalancer | undefined

push

  • push(...items: LoadBalancer[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: LoadBalancer[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): LoadBalancer
  • reduce(callbackfn: function, initialValue: LoadBalancer): LoadBalancer
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: LoadBalancer, currentValue: LoadBalancer, currentIndex: number, array: LoadBalancer[]): LoadBalancer
        • Parameters

          • previousValue: LoadBalancer
          • currentValue: LoadBalancer
          • currentIndex: number
          • array: LoadBalancer[]

          Returns LoadBalancer

    Returns LoadBalancer

  • Parameters

    • callbackfn: function
        • (previousValue: LoadBalancer, currentValue: LoadBalancer, currentIndex: number, array: LoadBalancer[]): LoadBalancer
        • Parameters

          • previousValue: LoadBalancer
          • currentValue: LoadBalancer
          • currentIndex: number
          • array: LoadBalancer[]

          Returns LoadBalancer

    • initialValue: LoadBalancer

    Returns LoadBalancer

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: LoadBalancer, currentIndex: number, array: LoadBalancer[]): U
        • Parameters

          • previousValue: U
          • currentValue: LoadBalancer
          • currentIndex: number
          • array: LoadBalancer[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): LoadBalancer
  • reduceRight(callbackfn: function, initialValue: LoadBalancer): LoadBalancer
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: LoadBalancer, currentValue: LoadBalancer, currentIndex: number, array: LoadBalancer[]): LoadBalancer
        • Parameters

          • previousValue: LoadBalancer
          • currentValue: LoadBalancer
          • currentIndex: number
          • array: LoadBalancer[]

          Returns LoadBalancer

    Returns LoadBalancer

  • Parameters

    • callbackfn: function
        • (previousValue: LoadBalancer, currentValue: LoadBalancer, currentIndex: number, array: LoadBalancer[]): LoadBalancer
        • Parameters

          • previousValue: LoadBalancer
          • currentValue: LoadBalancer
          • currentIndex: number
          • array: LoadBalancer[]

          Returns LoadBalancer

    • initialValue: LoadBalancer

    Returns LoadBalancer

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: LoadBalancer, currentIndex: number, array: LoadBalancer[]): U
        • Parameters

          • previousValue: U
          • currentValue: LoadBalancer
          • currentIndex: number
          • array: LoadBalancer[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): LoadBalancer[]
  • Reverses the elements in an Array.

    Returns LoadBalancer[]

shift

  • shift(): LoadBalancer | undefined
  • Removes the first element from an array and returns it.

    Returns LoadBalancer | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): LoadBalancer[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns LoadBalancer[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: LoadBalancer, index: number, array: LoadBalancer[]): boolean
        • Parameters

          • value: LoadBalancer
          • index: number
          • array: LoadBalancer[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): LoadBalancer[]
  • splice(start: number, deleteCount: number, ...items: LoadBalancer[]): LoadBalancer[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns LoadBalancer[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: LoadBalancer[]

      Elements to insert into the array in place of the deleted elements.

    Returns LoadBalancer[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: LoadBalancer[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: LoadBalancer[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<LoadBalancer>
  • Returns an iterable of values in the array

    Returns IterableIterator<LoadBalancer>

type

type: object

className

className: string = "NetworkInterfaceLoadBalancerListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LoadBalancer"

name

name: "Composite" = "Composite"

Const NetworkInterfaceTapConfiguration

NetworkInterfaceTapConfiguration: object

Tap configuration in a Network Interface.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the network interface tap configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "NetworkInterfaceTapConfiguration"

Optional virtualNetworkTap

virtualNetworkTap: VirtualNetworkTap

The reference of the Virtual Network Tap resource.

type

type: object

Sub Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "NetworkInterfaceTapConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

virtualNetworkTap

virtualNetworkTap: object

serializedName

serializedName: string = "properties.virtualNetworkTap"

type

type: object

className

className: string = "VirtualNetworkTap"

name

name: "Composite" = "Composite"

Const NetworkInterfaceTapConfigurationListResult

NetworkInterfaceTapConfigurationListResult: object
interface

Response for list tap configurations API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "NetworkInterfaceTapConfigurationListResult"

__@iterator

  • __@iterator(): IterableIterator<NetworkInterfaceTapConfiguration>
  • Iterator

    Returns IterableIterator<NetworkInterfaceTapConfiguration>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<NetworkInterfaceTapConfiguration>[]): NetworkInterfaceTapConfiguration[]
  • concat(...items: (T | ConcatArray<T>)[]): NetworkInterfaceTapConfiguration[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<NetworkInterfaceTapConfiguration>[]

      Additional items to add to the end of array1.

    Returns NetworkInterfaceTapConfiguration[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns NetworkInterfaceTapConfiguration[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, NetworkInterfaceTapConfiguration]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, NetworkInterfaceTapConfiguration]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: NetworkInterfaceTapConfiguration, index: number, array: NetworkInterfaceTapConfiguration[]): boolean
        • Parameters

          • value: NetworkInterfaceTapConfiguration
          • index: number
          • array: NetworkInterfaceTapConfiguration[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: NetworkInterfaceTapConfiguration, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: NetworkInterfaceTapConfiguration

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): NetworkInterfaceTapConfiguration[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: NetworkInterfaceTapConfiguration

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: NetworkInterfaceTapConfiguration, index: number, array: NetworkInterfaceTapConfiguration[]): boolean
        • Parameters

          • value: NetworkInterfaceTapConfiguration
          • index: number
          • array: NetworkInterfaceTapConfiguration[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: NetworkInterfaceTapConfiguration, index: number, array: NetworkInterfaceTapConfiguration[]): any
        • Parameters

          • value: NetworkInterfaceTapConfiguration
          • index: number
          • array: NetworkInterfaceTapConfiguration[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns NetworkInterfaceTapConfiguration[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): NetworkInterfaceTapConfiguration | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: NetworkInterfaceTapConfiguration

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: NetworkInterfaceTapConfiguration, index: number, obj: NetworkInterfaceTapConfiguration[]): boolean
        • Parameters

          • this: void
          • value: NetworkInterfaceTapConfiguration
          • index: number
          • obj: NetworkInterfaceTapConfiguration[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: NetworkInterfaceTapConfiguration, index: number, obj: NetworkInterfaceTapConfiguration[]): boolean
        • Parameters

          • value: NetworkInterfaceTapConfiguration
          • index: number
          • obj: NetworkInterfaceTapConfiguration[]

          Returns boolean

    • Optional thisArg: any

    Returns NetworkInterfaceTapConfiguration | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: NetworkInterfaceTapConfiguration, index: number, obj: NetworkInterfaceTapConfiguration[]): boolean
        • Parameters

          • value: NetworkInterfaceTapConfiguration
          • index: number
          • obj: NetworkInterfaceTapConfiguration[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: NetworkInterfaceTapConfiguration, index: number, array: NetworkInterfaceTapConfiguration[]): void
        • Parameters

          • value: NetworkInterfaceTapConfiguration
          • index: number
          • array: NetworkInterfaceTapConfiguration[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: NetworkInterfaceTapConfiguration, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: NetworkInterfaceTapConfiguration

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: NetworkInterfaceTapConfiguration, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: NetworkInterfaceTapConfiguration

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: NetworkInterfaceTapConfiguration, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: NetworkInterfaceTapConfiguration

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: NetworkInterfaceTapConfiguration, index: number, array: NetworkInterfaceTapConfiguration[]): U
        • Parameters

          • value: NetworkInterfaceTapConfiguration
          • index: number
          • array: NetworkInterfaceTapConfiguration[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): NetworkInterfaceTapConfiguration | undefined
  • Removes the last element from an array and returns it.

    Returns NetworkInterfaceTapConfiguration | undefined

push

  • push(...items: NetworkInterfaceTapConfiguration[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: NetworkInterfaceTapConfiguration[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): NetworkInterfaceTapConfiguration
  • reduce(callbackfn: function, initialValue: NetworkInterfaceTapConfiguration): NetworkInterfaceTapConfiguration
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: NetworkInterfaceTapConfiguration, currentValue: NetworkInterfaceTapConfiguration, currentIndex: number, array: NetworkInterfaceTapConfiguration[]): NetworkInterfaceTapConfiguration
        • Parameters

          • previousValue: NetworkInterfaceTapConfiguration
          • currentValue: NetworkInterfaceTapConfiguration
          • currentIndex: number
          • array: NetworkInterfaceTapConfiguration[]

          Returns NetworkInterfaceTapConfiguration

    Returns NetworkInterfaceTapConfiguration

  • Parameters

    • callbackfn: function
        • (previousValue: NetworkInterfaceTapConfiguration, currentValue: NetworkInterfaceTapConfiguration, currentIndex: number, array: NetworkInterfaceTapConfiguration[]): NetworkInterfaceTapConfiguration
        • Parameters

          • previousValue: NetworkInterfaceTapConfiguration
          • currentValue: NetworkInterfaceTapConfiguration
          • currentIndex: number
          • array: NetworkInterfaceTapConfiguration[]

          Returns NetworkInterfaceTapConfiguration

    • initialValue: NetworkInterfaceTapConfiguration

    Returns NetworkInterfaceTapConfiguration

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: NetworkInterfaceTapConfiguration, currentIndex: number, array: NetworkInterfaceTapConfiguration[]): U
        • Parameters

          • previousValue: U
          • currentValue: NetworkInterfaceTapConfiguration
          • currentIndex: number
          • array: NetworkInterfaceTapConfiguration[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): NetworkInterfaceTapConfiguration
  • reduceRight(callbackfn: function, initialValue: NetworkInterfaceTapConfiguration): NetworkInterfaceTapConfiguration
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: NetworkInterfaceTapConfiguration, currentValue: NetworkInterfaceTapConfiguration, currentIndex: number, array: NetworkInterfaceTapConfiguration[]): NetworkInterfaceTapConfiguration
        • Parameters

          • previousValue: NetworkInterfaceTapConfiguration
          • currentValue: NetworkInterfaceTapConfiguration
          • currentIndex: number
          • array: NetworkInterfaceTapConfiguration[]

          Returns NetworkInterfaceTapConfiguration

    Returns NetworkInterfaceTapConfiguration

  • Parameters

    • callbackfn: function
        • (previousValue: NetworkInterfaceTapConfiguration, currentValue: NetworkInterfaceTapConfiguration, currentIndex: number, array: NetworkInterfaceTapConfiguration[]): NetworkInterfaceTapConfiguration
        • Parameters

          • previousValue: NetworkInterfaceTapConfiguration
          • currentValue: NetworkInterfaceTapConfiguration
          • currentIndex: number
          • array: NetworkInterfaceTapConfiguration[]

          Returns NetworkInterfaceTapConfiguration

    • initialValue: NetworkInterfaceTapConfiguration

    Returns NetworkInterfaceTapConfiguration

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: NetworkInterfaceTapConfiguration, currentIndex: number, array: NetworkInterfaceTapConfiguration[]): U
        • Parameters

          • previousValue: U
          • currentValue: NetworkInterfaceTapConfiguration
          • currentIndex: number
          • array: NetworkInterfaceTapConfiguration[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): NetworkInterfaceTapConfiguration[]
  • Reverses the elements in an Array.

    Returns NetworkInterfaceTapConfiguration[]

shift

  • shift(): NetworkInterfaceTapConfiguration | undefined
  • Removes the first element from an array and returns it.

    Returns NetworkInterfaceTapConfiguration | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): NetworkInterfaceTapConfiguration[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns NetworkInterfaceTapConfiguration[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: NetworkInterfaceTapConfiguration, index: number, array: NetworkInterfaceTapConfiguration[]): boolean
        • Parameters

          • value: NetworkInterfaceTapConfiguration
          • index: number
          • array: NetworkInterfaceTapConfiguration[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): NetworkInterfaceTapConfiguration[]
  • splice(start: number, deleteCount: number, ...items: NetworkInterfaceTapConfiguration[]): NetworkInterfaceTapConfiguration[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns NetworkInterfaceTapConfiguration[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: NetworkInterfaceTapConfiguration[]

      Elements to insert into the array in place of the deleted elements.

    Returns NetworkInterfaceTapConfiguration[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: NetworkInterfaceTapConfiguration[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: NetworkInterfaceTapConfiguration[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<NetworkInterfaceTapConfiguration>
  • Returns an iterable of values in the array

    Returns IterableIterator<NetworkInterfaceTapConfiguration>

type

type: object

className

className: string = "NetworkInterfaceTapConfigurationListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NetworkInterfaceTapConfiguration"

name

name: "Composite" = "Composite"

Const NetworkProfile

NetworkProfile: object

Network profile resource.

Optional containerNetworkInterfaceConfigurations

containerNetworkInterfaceConfigurations: ContainerNetworkInterfaceConfiguration[]

List of chid container network interface configurations.

Optional containerNetworkInterfaces

containerNetworkInterfaces: ContainerNetworkInterface[]

List of child container network interfaces.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceGuid

resourceGuid: undefined | string

The resource GUID property of the network interface resource. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "NetworkProfile"

Optional tags

tags: undefined | object

Resource tags.

type

type: object

className

className: string = "NetworkProfile"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

containerNetworkInterfaceConfigurations

containerNetworkInterfaceConfigurations: object

serializedName

serializedName: string = "properties.containerNetworkInterfaceConfigurations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ContainerNetworkInterfaceConfiguration"

name

name: "Composite" = "Composite"

containerNetworkInterfaces

containerNetworkInterfaces: object

serializedName

serializedName: string = "properties.containerNetworkInterfaces"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ContainerNetworkInterface"

name

name: "Composite" = "Composite"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

resourceGuid

resourceGuid: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.resourceGuid"

type

type: object

name

name: "String" = "String"

Const NetworkProfileListResult

NetworkProfileListResult: object
interface

Response for ListNetworkProfiles API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "NetworkProfileListResult"

__@iterator

  • __@iterator(): IterableIterator<NetworkProfile>
  • Iterator

    Returns IterableIterator<NetworkProfile>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<NetworkProfile>[]): NetworkProfile[]
  • concat(...items: (T | ConcatArray<T>)[]): NetworkProfile[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<NetworkProfile>[]

      Additional items to add to the end of array1.

    Returns NetworkProfile[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns NetworkProfile[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, NetworkProfile]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, NetworkProfile]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: NetworkProfile, index: number, array: NetworkProfile[]): boolean
        • Parameters

          • value: NetworkProfile
          • index: number
          • array: NetworkProfile[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: NetworkProfile, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: NetworkProfile

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): NetworkProfile[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: NetworkProfile

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: NetworkProfile, index: number, array: NetworkProfile[]): boolean
        • Parameters

          • value: NetworkProfile
          • index: number
          • array: NetworkProfile[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: NetworkProfile, index: number, array: NetworkProfile[]): any
        • Parameters

          • value: NetworkProfile
          • index: number
          • array: NetworkProfile[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns NetworkProfile[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): NetworkProfile | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: NetworkProfile

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: NetworkProfile, index: number, obj: NetworkProfile[]): boolean
        • Parameters

          • this: void
          • value: NetworkProfile
          • index: number
          • obj: NetworkProfile[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: NetworkProfile, index: number, obj: NetworkProfile[]): boolean
        • Parameters

          • value: NetworkProfile
          • index: number
          • obj: NetworkProfile[]

          Returns boolean

    • Optional thisArg: any

    Returns NetworkProfile | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: NetworkProfile, index: number, obj: NetworkProfile[]): boolean
        • Parameters

          • value: NetworkProfile
          • index: number
          • obj: NetworkProfile[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: NetworkProfile, index: number, array: NetworkProfile[]): void
        • Parameters

          • value: NetworkProfile
          • index: number
          • array: NetworkProfile[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: NetworkProfile, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: NetworkProfile

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: NetworkProfile, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: NetworkProfile

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: NetworkProfile, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: NetworkProfile

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: NetworkProfile, index: number, array: NetworkProfile[]): U
        • Parameters

          • value: NetworkProfile
          • index: number
          • array: NetworkProfile[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): NetworkProfile | undefined
  • Removes the last element from an array and returns it.

    Returns NetworkProfile | undefined

push

  • push(...items: NetworkProfile[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: NetworkProfile[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): NetworkProfile
  • reduce(callbackfn: function, initialValue: NetworkProfile): NetworkProfile
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: NetworkProfile, currentValue: NetworkProfile, currentIndex: number, array: NetworkProfile[]): NetworkProfile
        • Parameters

          • previousValue: NetworkProfile
          • currentValue: NetworkProfile
          • currentIndex: number
          • array: NetworkProfile[]

          Returns NetworkProfile

    Returns NetworkProfile

  • Parameters

    • callbackfn: function
        • (previousValue: NetworkProfile, currentValue: NetworkProfile, currentIndex: number, array: NetworkProfile[]): NetworkProfile
        • Parameters

          • previousValue: NetworkProfile
          • currentValue: NetworkProfile
          • currentIndex: number
          • array: NetworkProfile[]

          Returns NetworkProfile

    • initialValue: NetworkProfile

    Returns NetworkProfile

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: NetworkProfile, currentIndex: number, array: NetworkProfile[]): U
        • Parameters

          • previousValue: U
          • currentValue: NetworkProfile
          • currentIndex: number
          • array: NetworkProfile[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): NetworkProfile
  • reduceRight(callbackfn: function, initialValue: NetworkProfile): NetworkProfile
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: NetworkProfile, currentValue: NetworkProfile, currentIndex: number, array: NetworkProfile[]): NetworkProfile
        • Parameters

          • previousValue: NetworkProfile
          • currentValue: NetworkProfile
          • currentIndex: number
          • array: NetworkProfile[]

          Returns NetworkProfile

    Returns NetworkProfile

  • Parameters

    • callbackfn: function
        • (previousValue: NetworkProfile, currentValue: NetworkProfile, currentIndex: number, array: NetworkProfile[]): NetworkProfile
        • Parameters

          • previousValue: NetworkProfile
          • currentValue: NetworkProfile
          • currentIndex: number
          • array: NetworkProfile[]

          Returns NetworkProfile

    • initialValue: NetworkProfile

    Returns NetworkProfile

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: NetworkProfile, currentIndex: number, array: NetworkProfile[]): U
        • Parameters

          • previousValue: U
          • currentValue: NetworkProfile
          • currentIndex: number
          • array: NetworkProfile[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): NetworkProfile[]
  • Reverses the elements in an Array.

    Returns NetworkProfile[]

shift

  • shift(): NetworkProfile | undefined
  • Removes the first element from an array and returns it.

    Returns NetworkProfile | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): NetworkProfile[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns NetworkProfile[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: NetworkProfile, index: number, array: NetworkProfile[]): boolean
        • Parameters

          • value: NetworkProfile
          • index: number
          • array: NetworkProfile[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): NetworkProfile[]
  • splice(start: number, deleteCount: number, ...items: NetworkProfile[]): NetworkProfile[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns NetworkProfile[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: NetworkProfile[]

      Elements to insert into the array in place of the deleted elements.

    Returns NetworkProfile[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: NetworkProfile[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: NetworkProfile[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<NetworkProfile>
  • Returns an iterable of values in the array

    Returns IterableIterator<NetworkProfile>

type

type: object

className

className: string = "NetworkProfileListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NetworkProfile"

name

name: "Composite" = "Composite"

Const NetworkSecurityGroup

NetworkSecurityGroup: object

NetworkSecurityGroup resource.

Optional defaultSecurityRules

defaultSecurityRules: SecurityRule[]

The default security rules of network security group.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional networkInterfaces

networkInterfaces: NetworkInterface[]

A collection of references to network interfaces. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

Optional resourceGuid

resourceGuid: undefined | string

The resource GUID property of the network security group resource.

Optional securityRules

securityRules: SecurityRule[]

A collection of security rules of the network security group.

serializedName

serializedName: string = "NetworkSecurityGroup"

Optional subnets

subnets: Subnet[]

A collection of references to subnets. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object

Resource tags.

type

type: object

className

className: string = "NetworkSecurityGroup"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

defaultSecurityRules

defaultSecurityRules: object

serializedName

serializedName: string = "properties.defaultSecurityRules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SecurityRule"

name

name: "Composite" = "Composite"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

networkInterfaces

networkInterfaces: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.networkInterfaces"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NetworkInterface"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

resourceGuid

resourceGuid: object

serializedName

serializedName: string = "properties.resourceGuid"

type

type: object

name

name: "String" = "String"

securityRules

securityRules: object

serializedName

serializedName: string = "properties.securityRules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SecurityRule"

name

name: "Composite" = "Composite"

subnets

subnets: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.subnets"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Subnet"

name

name: "Composite" = "Composite"

Const NetworkSecurityGroupListResult

NetworkSecurityGroupListResult: object
interface

Response for ListNetworkSecurityGroups API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "NetworkSecurityGroupListResult"

__@iterator

  • __@iterator(): IterableIterator<NetworkSecurityGroup>
  • Iterator

    Returns IterableIterator<NetworkSecurityGroup>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<NetworkSecurityGroup>[]): NetworkSecurityGroup[]
  • concat(...items: (T | ConcatArray<T>)[]): NetworkSecurityGroup[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<NetworkSecurityGroup>[]

      Additional items to add to the end of array1.

    Returns NetworkSecurityGroup[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns NetworkSecurityGroup[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, NetworkSecurityGroup]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, NetworkSecurityGroup]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: NetworkSecurityGroup, index: number, array: NetworkSecurityGroup[]): boolean
        • Parameters

          • value: NetworkSecurityGroup
          • index: number
          • array: NetworkSecurityGroup[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: NetworkSecurityGroup, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: NetworkSecurityGroup

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): NetworkSecurityGroup[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: NetworkSecurityGroup

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: NetworkSecurityGroup, index: number, array: NetworkSecurityGroup[]): boolean
        • Parameters

          • value: NetworkSecurityGroup
          • index: number
          • array: NetworkSecurityGroup[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: NetworkSecurityGroup, index: number, array: NetworkSecurityGroup[]): any
        • Parameters

          • value: NetworkSecurityGroup
          • index: number
          • array: NetworkSecurityGroup[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns NetworkSecurityGroup[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): NetworkSecurityGroup | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: NetworkSecurityGroup

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: NetworkSecurityGroup, index: number, obj: NetworkSecurityGroup[]): boolean
        • Parameters

          • this: void
          • value: NetworkSecurityGroup
          • index: number
          • obj: NetworkSecurityGroup[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: NetworkSecurityGroup, index: number, obj: NetworkSecurityGroup[]): boolean
        • Parameters

          • value: NetworkSecurityGroup
          • index: number
          • obj: NetworkSecurityGroup[]

          Returns boolean

    • Optional thisArg: any

    Returns NetworkSecurityGroup | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: NetworkSecurityGroup, index: number, obj: NetworkSecurityGroup[]): boolean
        • Parameters

          • value: NetworkSecurityGroup
          • index: number
          • obj: NetworkSecurityGroup[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: NetworkSecurityGroup, index: number, array: NetworkSecurityGroup[]): void
        • Parameters

          • value: NetworkSecurityGroup
          • index: number
          • array: NetworkSecurityGroup[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: NetworkSecurityGroup, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: NetworkSecurityGroup

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: NetworkSecurityGroup, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: NetworkSecurityGroup

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: NetworkSecurityGroup, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: NetworkSecurityGroup

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: NetworkSecurityGroup, index: number, array: NetworkSecurityGroup[]): U
        • Parameters

          • value: NetworkSecurityGroup
          • index: number
          • array: NetworkSecurityGroup[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): NetworkSecurityGroup | undefined
  • Removes the last element from an array and returns it.

    Returns NetworkSecurityGroup | undefined

push

  • push(...items: NetworkSecurityGroup[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: NetworkSecurityGroup[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): NetworkSecurityGroup
  • reduce(callbackfn: function, initialValue: NetworkSecurityGroup): NetworkSecurityGroup
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: NetworkSecurityGroup, currentValue: NetworkSecurityGroup, currentIndex: number, array: NetworkSecurityGroup[]): NetworkSecurityGroup
        • Parameters

          • previousValue: NetworkSecurityGroup
          • currentValue: NetworkSecurityGroup
          • currentIndex: number
          • array: NetworkSecurityGroup[]

          Returns NetworkSecurityGroup

    Returns NetworkSecurityGroup

  • Parameters

    • callbackfn: function
        • (previousValue: NetworkSecurityGroup, currentValue: NetworkSecurityGroup, currentIndex: number, array: NetworkSecurityGroup[]): NetworkSecurityGroup
        • Parameters

          • previousValue: NetworkSecurityGroup
          • currentValue: NetworkSecurityGroup
          • currentIndex: number
          • array: NetworkSecurityGroup[]

          Returns NetworkSecurityGroup

    • initialValue: NetworkSecurityGroup

    Returns NetworkSecurityGroup

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: NetworkSecurityGroup, currentIndex: number, array: NetworkSecurityGroup[]): U
        • Parameters

          • previousValue: U
          • currentValue: NetworkSecurityGroup
          • currentIndex: number
          • array: NetworkSecurityGroup[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): NetworkSecurityGroup
  • reduceRight(callbackfn: function, initialValue: NetworkSecurityGroup): NetworkSecurityGroup
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: NetworkSecurityGroup, currentValue: NetworkSecurityGroup, currentIndex: number, array: NetworkSecurityGroup[]): NetworkSecurityGroup
        • Parameters

          • previousValue: NetworkSecurityGroup
          • currentValue: NetworkSecurityGroup
          • currentIndex: number
          • array: NetworkSecurityGroup[]

          Returns NetworkSecurityGroup

    Returns NetworkSecurityGroup

  • Parameters

    • callbackfn: function
        • (previousValue: NetworkSecurityGroup, currentValue: NetworkSecurityGroup, currentIndex: number, array: NetworkSecurityGroup[]): NetworkSecurityGroup
        • Parameters

          • previousValue: NetworkSecurityGroup
          • currentValue: NetworkSecurityGroup
          • currentIndex: number
          • array: NetworkSecurityGroup[]

          Returns NetworkSecurityGroup

    • initialValue: NetworkSecurityGroup

    Returns NetworkSecurityGroup

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: NetworkSecurityGroup, currentIndex: number, array: NetworkSecurityGroup[]): U
        • Parameters

          • previousValue: U
          • currentValue: NetworkSecurityGroup
          • currentIndex: number
          • array: NetworkSecurityGroup[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): NetworkSecurityGroup[]
  • Reverses the elements in an Array.

    Returns NetworkSecurityGroup[]

shift

  • shift(): NetworkSecurityGroup | undefined
  • Removes the first element from an array and returns it.

    Returns NetworkSecurityGroup | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): NetworkSecurityGroup[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns NetworkSecurityGroup[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: NetworkSecurityGroup, index: number, array: NetworkSecurityGroup[]): boolean
        • Parameters

          • value: NetworkSecurityGroup
          • index: number
          • array: NetworkSecurityGroup[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): NetworkSecurityGroup[]
  • splice(start: number, deleteCount: number, ...items: NetworkSecurityGroup[]): NetworkSecurityGroup[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns NetworkSecurityGroup[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: NetworkSecurityGroup[]

      Elements to insert into the array in place of the deleted elements.

    Returns NetworkSecurityGroup[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: NetworkSecurityGroup[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: NetworkSecurityGroup[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<NetworkSecurityGroup>
  • Returns an iterable of values in the array

    Returns IterableIterator<NetworkSecurityGroup>

type

type: object

className

className: string = "NetworkSecurityGroupListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NetworkSecurityGroup"

name

name: "Composite" = "Composite"

Const NetworkSecurityGroupResult

NetworkSecurityGroupResult: object

Network configuration diagnostic result corresponded provided traffic query.

Optional evaluatedNetworkSecurityGroups

evaluatedNetworkSecurityGroups: EvaluatedNetworkSecurityGroup[]

List of results network security groups diagnostic. NOTE: This property will not be serialized. It can only be populated by the server.

Optional securityRuleAccessResult

securityRuleAccessResult: SecurityRuleAccess

The network traffic is allowed or denied. Possible values include: 'Allow', 'Deny'

serializedName

serializedName: string = "NetworkSecurityGroupResult"

type

type: object

className

className: string = "NetworkSecurityGroupResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

evaluatedNetworkSecurityGroups

evaluatedNetworkSecurityGroups: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "evaluatedNetworkSecurityGroups"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "EvaluatedNetworkSecurityGroup"

name

name: "Composite" = "Composite"

securityRuleAccessResult

securityRuleAccessResult: object

serializedName

serializedName: string = "securityRuleAccessResult"

type

type: object

name

name: "String" = "String"

Const NetworkSecurityRulesEvaluationResult

NetworkSecurityRulesEvaluationResult: object

Network security rules evaluation result.

Optional destinationMatched

destinationMatched: undefined | false | true

Value indicating whether destination is matched.

Optional destinationPortMatched

destinationPortMatched: undefined | false | true

Value indicating whether destination port is matched.

Optional name

name: undefined | string

Name of the network security rule.

Optional protocolMatched

protocolMatched: undefined | false | true

Value indicating whether protocol is matched.

serializedName

serializedName: string = "NetworkSecurityRulesEvaluationResult"

Optional sourceMatched

sourceMatched: undefined | false | true

Value indicating whether source is matched.

Optional sourcePortMatched

sourcePortMatched: undefined | false | true

Value indicating whether source port is matched.

type

type: object

className

className: string = "NetworkSecurityRulesEvaluationResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

destinationMatched

destinationMatched: object

serializedName

serializedName: string = "destinationMatched"

type

type: object

name

name: "Boolean" = "Boolean"

destinationPortMatched

destinationPortMatched: object

serializedName

serializedName: string = "destinationPortMatched"

type

type: object

name

name: "Boolean" = "Boolean"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

protocolMatched

protocolMatched: object

serializedName

serializedName: string = "protocolMatched"

type

type: object

name

name: "Boolean" = "Boolean"

sourceMatched

sourceMatched: object

serializedName

serializedName: string = "sourceMatched"

type

type: object

name

name: "Boolean" = "Boolean"

sourcePortMatched

sourcePortMatched: object

serializedName

serializedName: string = "sourcePortMatched"

type

type: object

name

name: "Boolean" = "Boolean"

Const NetworkWatcher

NetworkWatcher: object

Network watcher in a resource group.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: ProvisioningState

The provisioning state of the resource. Possible values include: 'Succeeded', 'Updating', 'Deleting', 'Failed'

serializedName

serializedName: string = "NetworkWatcher"

Optional tags

tags: undefined | object

Resource tags.

type

type: object

className

className: string = "NetworkWatcher"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

Const NetworkWatcherListResult

NetworkWatcherListResult: object
interface

Response for ListNetworkWatchers API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "NetworkWatcherListResult"

__@iterator

  • __@iterator(): IterableIterator<NetworkWatcher>
  • Iterator

    Returns IterableIterator<NetworkWatcher>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<NetworkWatcher>[]): NetworkWatcher[]
  • concat(...items: (T | ConcatArray<T>)[]): NetworkWatcher[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<NetworkWatcher>[]

      Additional items to add to the end of array1.

    Returns NetworkWatcher[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns NetworkWatcher[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, NetworkWatcher]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, NetworkWatcher]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: NetworkWatcher, index: number, array: NetworkWatcher[]): boolean
        • Parameters

          • value: NetworkWatcher
          • index: number
          • array: NetworkWatcher[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: NetworkWatcher, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: NetworkWatcher

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): NetworkWatcher[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: NetworkWatcher

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: NetworkWatcher, index: number, array: NetworkWatcher[]): boolean
        • Parameters

          • value: NetworkWatcher
          • index: number
          • array: NetworkWatcher[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: NetworkWatcher, index: number, array: NetworkWatcher[]): any
        • Parameters

          • value: NetworkWatcher
          • index: number
          • array: NetworkWatcher[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns NetworkWatcher[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): NetworkWatcher | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: NetworkWatcher

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: NetworkWatcher, index: number, obj: NetworkWatcher[]): boolean
        • Parameters

          • this: void
          • value: NetworkWatcher
          • index: number
          • obj: NetworkWatcher[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: NetworkWatcher, index: number, obj: NetworkWatcher[]): boolean
        • Parameters

          • value: NetworkWatcher
          • index: number
          • obj: NetworkWatcher[]

          Returns boolean

    • Optional thisArg: any

    Returns NetworkWatcher | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: NetworkWatcher, index: number, obj: NetworkWatcher[]): boolean
        • Parameters

          • value: NetworkWatcher
          • index: number
          • obj: NetworkWatcher[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: NetworkWatcher, index: number, array: NetworkWatcher[]): void
        • Parameters

          • value: NetworkWatcher
          • index: number
          • array: NetworkWatcher[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: NetworkWatcher, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: NetworkWatcher

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: NetworkWatcher, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: NetworkWatcher

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: NetworkWatcher, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: NetworkWatcher

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: NetworkWatcher, index: number, array: NetworkWatcher[]): U
        • Parameters

          • value: NetworkWatcher
          • index: number
          • array: NetworkWatcher[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): NetworkWatcher | undefined
  • Removes the last element from an array and returns it.

    Returns NetworkWatcher | undefined

push

  • push(...items: NetworkWatcher[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: NetworkWatcher[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): NetworkWatcher
  • reduce(callbackfn: function, initialValue: NetworkWatcher): NetworkWatcher
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: NetworkWatcher, currentValue: NetworkWatcher, currentIndex: number, array: NetworkWatcher[]): NetworkWatcher
        • Parameters

          • previousValue: NetworkWatcher
          • currentValue: NetworkWatcher
          • currentIndex: number
          • array: NetworkWatcher[]

          Returns NetworkWatcher

    Returns NetworkWatcher

  • Parameters

    • callbackfn: function
        • (previousValue: NetworkWatcher, currentValue: NetworkWatcher, currentIndex: number, array: NetworkWatcher[]): NetworkWatcher
        • Parameters

          • previousValue: NetworkWatcher
          • currentValue: NetworkWatcher
          • currentIndex: number
          • array: NetworkWatcher[]

          Returns NetworkWatcher

    • initialValue: NetworkWatcher

    Returns NetworkWatcher

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: NetworkWatcher, currentIndex: number, array: NetworkWatcher[]): U
        • Parameters

          • previousValue: U
          • currentValue: NetworkWatcher
          • currentIndex: number
          • array: NetworkWatcher[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): NetworkWatcher
  • reduceRight(callbackfn: function, initialValue: NetworkWatcher): NetworkWatcher
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: NetworkWatcher, currentValue: NetworkWatcher, currentIndex: number, array: NetworkWatcher[]): NetworkWatcher
        • Parameters

          • previousValue: NetworkWatcher
          • currentValue: NetworkWatcher
          • currentIndex: number
          • array: NetworkWatcher[]

          Returns NetworkWatcher

    Returns NetworkWatcher

  • Parameters

    • callbackfn: function
        • (previousValue: NetworkWatcher, currentValue: NetworkWatcher, currentIndex: number, array: NetworkWatcher[]): NetworkWatcher
        • Parameters

          • previousValue: NetworkWatcher
          • currentValue: NetworkWatcher
          • currentIndex: number
          • array: NetworkWatcher[]

          Returns NetworkWatcher

    • initialValue: NetworkWatcher

    Returns NetworkWatcher

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: NetworkWatcher, currentIndex: number, array: NetworkWatcher[]): U
        • Parameters

          • previousValue: U
          • currentValue: NetworkWatcher
          • currentIndex: number
          • array: NetworkWatcher[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): NetworkWatcher[]
  • Reverses the elements in an Array.

    Returns NetworkWatcher[]

shift

  • shift(): NetworkWatcher | undefined
  • Removes the first element from an array and returns it.

    Returns NetworkWatcher | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): NetworkWatcher[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns NetworkWatcher[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: NetworkWatcher, index: number, array: NetworkWatcher[]): boolean
        • Parameters

          • value: NetworkWatcher
          • index: number
          • array: NetworkWatcher[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): NetworkWatcher[]
  • splice(start: number, deleteCount: number, ...items: NetworkWatcher[]): NetworkWatcher[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns NetworkWatcher[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: NetworkWatcher[]

      Elements to insert into the array in place of the deleted elements.

    Returns NetworkWatcher[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: NetworkWatcher[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: NetworkWatcher[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<NetworkWatcher>
  • Returns an iterable of values in the array

    Returns IterableIterator<NetworkWatcher>

type

type: object

className

className: string = "NetworkWatcherListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NetworkWatcher"

name

name: "Composite" = "Composite"

Const NextHopParameters

NextHopParameters: object

Parameters that define the source and destination endpoint.

destinationIPAddress

destinationIPAddress: string

The destination IP address.

serializedName

serializedName: string = "NextHopParameters"

sourceIPAddress

sourceIPAddress: string

The source IP address.

Optional targetNicResourceId

targetNicResourceId: undefined | string

The NIC ID. (If VM has multiple NICs and IP forwarding is enabled on any of the nics, then this parameter must be specified. Otherwise optional).

targetResourceId

targetResourceId: string

The resource identifier of the target resource against which the action is to be performed.

type

type: object

className

className: string = "NextHopParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

destinationIPAddress

destinationIPAddress: object

required

required: true = true

serializedName

serializedName: string = "destinationIPAddress"

type

type: object

name

name: "String" = "String"

sourceIPAddress

sourceIPAddress: object

required

required: true = true

serializedName

serializedName: string = "sourceIPAddress"

type

type: object

name

name: "String" = "String"

targetNicResourceId

targetNicResourceId: object

serializedName

serializedName: string = "targetNicResourceId"

type

type: object

name

name: "String" = "String"

targetResourceId

targetResourceId: object

required

required: true = true

serializedName

serializedName: string = "targetResourceId"

type

type: object

name

name: "String" = "String"

Const NextHopResult

NextHopResult: object

The information about next hop from the specified VM.

Optional nextHopIpAddress

nextHopIpAddress: undefined | string

Next hop IP Address.

Optional nextHopType

nextHopType: NextHopType

Next hop type. Possible values include: 'Internet', 'VirtualAppliance', 'VirtualNetworkGateway', 'VnetLocal', 'HyperNetGateway', 'None'

Optional routeTableId

routeTableId: undefined | string

The resource identifier for the route table associated with the route being returned. If the route being returned does not correspond to any user created routes then this field will be the string 'System Route'.

serializedName

serializedName: string = "NextHopResult"

type

type: object

className

className: string = "NextHopResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextHopIpAddress

nextHopIpAddress: object

serializedName

serializedName: string = "nextHopIpAddress"

type

type: object

name

name: "String" = "String"

nextHopType

nextHopType: object

serializedName

serializedName: string = "nextHopType"

type

type: object

name

name: "String" = "String"

routeTableId

routeTableId: object

serializedName

serializedName: string = "routeTableId"

type

type: object

name

name: "String" = "String"

Const Operation

Operation: object

Network REST API operation definition.

Optional display

Display metadata associated with the operation.

Optional name

name: undefined | string

Operation name: {provider}/{resource}/{operation}.

Optional origin

origin: undefined | string

Origin of the operation.

serializedName

serializedName: string = "Operation"

Optional serviceSpecification

Specification of the service.

type

type: object

className

className: string = "Operation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

display

display: object

serializedName

serializedName: string = "display"

type

type: object

className

className: string = "OperationDisplay"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

origin

origin: object

serializedName

serializedName: string = "origin"

type

type: object

name

name: "String" = "String"

serviceSpecification

serviceSpecification: object

serializedName

serializedName: string = "properties.serviceSpecification"

type

type: object

className

className: string = "OperationPropertiesFormatServiceSpecification"

name

name: "Composite" = "Composite"

Const OperationDisplay

OperationDisplay: object

Display metadata associated with the operation.

Optional description

description: undefined | string

Description of the operation.

Optional operation

operation: undefined | string

Type of the operation: get, read, delete, etc.

Optional provider

provider: undefined | string

Service provider: Microsoft Network.

Optional resource

resource: undefined | string

Resource on which the operation is performed.

serializedName

serializedName: string = "Operation_display"

type

type: object

className

className: string = "OperationDisplay"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "String" = "String"

operation

operation: object

serializedName

serializedName: string = "operation"

type

type: object

name

name: "String" = "String"

provider

provider: object

serializedName

serializedName: string = "provider"

type

type: object

name

name: "String" = "String"

resource

resource: object

serializedName

serializedName: string = "resource"

type

type: object

name

name: "String" = "String"

Const OperationListResult

OperationListResult: object
interface

Result of the request to list Network operations. It contains a list of operations and a URL link to get the next set of results.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

URL to get the next set of operation list results if there are any.

serializedName

serializedName: string = "OperationListResult"

__@iterator

  • __@iterator(): IterableIterator<Operation>
  • Iterator

    Returns IterableIterator<Operation>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Operation>[]): Operation[]
  • concat(...items: (T | ConcatArray<T>)[]): Operation[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Operation>[]

      Additional items to add to the end of array1.

    Returns Operation[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Operation[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Operation]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Operation]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: Operation, index: number, array: Operation[]): boolean
        • Parameters

          • value: Operation
          • index: number
          • array: Operation[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Operation, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Operation

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Operation[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: Operation

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Operation, index: number, array: Operation[]): boolean
        • Parameters

          • value: Operation
          • index: number
          • array: Operation[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Operation, index: number, array: Operation[]): any
        • Parameters

          • value: Operation
          • index: number
          • array: Operation[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Operation[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Operation | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: Operation

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Operation, index: number, obj: Operation[]): boolean
        • Parameters

          • this: void
          • value: Operation
          • index: number
          • obj: Operation[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: Operation, index: number, obj: Operation[]): boolean
        • Parameters

          • value: Operation
          • index: number
          • obj: Operation[]

          Returns boolean

    • Optional thisArg: any

    Returns Operation | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: Operation, index: number, obj: Operation[]): boolean
        • Parameters

          • value: Operation
          • index: number
          • obj: Operation[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: Operation, index: number, array: Operation[]): void
        • Parameters

          • value: Operation
          • index: number
          • array: Operation[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Operation, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Operation

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Operation, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Operation

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Operation, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Operation

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: Operation, index: number, array: Operation[]): U
        • Parameters

          • value: Operation
          • index: number
          • array: Operation[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): Operation | undefined
  • Removes the last element from an array and returns it.

    Returns Operation | undefined

push

  • push(...items: Operation[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Operation[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Operation
  • reduce(callbackfn: function, initialValue: Operation): Operation
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: Operation, currentValue: Operation, currentIndex: number, array: Operation[]): Operation
        • Parameters

          • previousValue: Operation
          • currentValue: Operation
          • currentIndex: number
          • array: Operation[]

          Returns Operation

    Returns Operation

  • Parameters

    • callbackfn: function
        • (previousValue: Operation, currentValue: Operation, currentIndex: number, array: Operation[]): Operation
        • Parameters

          • previousValue: Operation
          • currentValue: Operation
          • currentIndex: number
          • array: Operation[]

          Returns Operation

    • initialValue: Operation

    Returns Operation

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Operation, currentIndex: number, array: Operation[]): U
        • Parameters

          • previousValue: U
          • currentValue: Operation
          • currentIndex: number
          • array: Operation[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Operation
  • reduceRight(callbackfn: function, initialValue: Operation): Operation
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: Operation, currentValue: Operation, currentIndex: number, array: Operation[]): Operation
        • Parameters

          • previousValue: Operation
          • currentValue: Operation
          • currentIndex: number
          • array: Operation[]

          Returns Operation

    Returns Operation

  • Parameters

    • callbackfn: function
        • (previousValue: Operation, currentValue: Operation, currentIndex: number, array: Operation[]): Operation
        • Parameters

          • previousValue: Operation
          • currentValue: Operation
          • currentIndex: number
          • array: Operation[]

          Returns Operation

    • initialValue: Operation

    Returns Operation

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Operation, currentIndex: number, array: Operation[]): U
        • Parameters

          • previousValue: U
          • currentValue: Operation
          • currentIndex: number
          • array: Operation[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): Operation[]
  • Reverses the elements in an Array.

    Returns Operation[]

shift

  • shift(): Operation | undefined
  • Removes the first element from an array and returns it.

    Returns Operation | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Operation[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Operation[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: Operation, index: number, array: Operation[]): boolean
        • Parameters

          • value: Operation
          • index: number
          • array: Operation[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Operation[]
  • splice(start: number, deleteCount: number, ...items: Operation[]): Operation[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Operation[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Operation[]

      Elements to insert into the array in place of the deleted elements.

    Returns Operation[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Operation[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Operation[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Operation>
  • Returns an iterable of values in the array

    Returns IterableIterator<Operation>

type

type: object

className

className: string = "OperationListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Operation"

name

name: "Composite" = "Composite"

Const OperationPropertiesFormatServiceSpecification

OperationPropertiesFormatServiceSpecification: object

Specification of the service.

Optional logSpecifications

logSpecifications: LogSpecification[]

Operation log specification.

Optional metricSpecifications

metricSpecifications: MetricSpecification[]

Operation service specification.

serializedName

serializedName: string = "OperationPropertiesFormat_serviceSpecification"

type

type: object

className

className: string = "OperationPropertiesFormatServiceSpecification"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

logSpecifications

logSpecifications: object

serializedName

serializedName: string = "logSpecifications"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LogSpecification"

name

name: "Composite" = "Composite"

metricSpecifications

metricSpecifications: object

serializedName

serializedName: string = "metricSpecifications"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MetricSpecification"

name

name: "Composite" = "Composite"

Const OutboundRule

OutboundRule: object

Outbound pool of the load balancer.

Optional allocatedOutboundPorts

allocatedOutboundPorts: undefined | number

The number of outbound ports to be used for NAT.

backendAddressPool

backendAddressPool: SubResource

A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs.

Optional enableTcpReset

enableTcpReset: undefined | false | true

Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

frontendIPConfigurations

frontendIPConfigurations: SubResource[]

The Frontend IP addresses of the load balancer.

Optional id

id: undefined | string

Resource ID.

Optional idleTimeoutInMinutes

idleTimeoutInMinutes: undefined | number

The timeout for the TCP idle connection.

Optional name

name: undefined | string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

protocol

The protocol for the outbound rule in load balancer. Possible values include: 'Tcp', 'Udp', 'All'

Optional provisioningState

provisioningState: undefined | string

Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

serializedName

serializedName: string = "OutboundRule"

type

type: object

className

className: string = "OutboundRule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

allocatedOutboundPorts

allocatedOutboundPorts: object

serializedName

serializedName: string = "properties.allocatedOutboundPorts"

type

type: object

name

name: "Number" = "Number"

backendAddressPool

backendAddressPool: object

required

required: true = true

serializedName

serializedName: string = "properties.backendAddressPool"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

enableTcpReset

enableTcpReset: object

serializedName

serializedName: string = "properties.enableTcpReset"

type

type: object

name

name: "Boolean" = "Boolean"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

frontendIPConfigurations

frontendIPConfigurations: object

required

required: true = true

serializedName

serializedName: string = "properties.frontendIPConfigurations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

idleTimeoutInMinutes

idleTimeoutInMinutes: object

serializedName

serializedName: string = "properties.idleTimeoutInMinutes"

type

type: object

name

name: "Number" = "Number"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

protocol

protocol: object

required

required: true = true

serializedName

serializedName: string = "properties.protocol"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

Const P2SVpnGateway

P2SVpnGateway: object

P2SVpnGateway Resource.

Optional customRoutes

customRoutes: AddressSpace

The reference of the address space resource which represents the custom routes specified by the customer for P2SVpnGateway and P2S VpnClient.

Optional etag

etag: undefined | string

Gets a unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional p2SVpnServerConfiguration

p2SVpnServerConfiguration: SubResource

The P2SVpnServerConfiguration to which the p2sVpnGateway is attached to.

Optional provisioningState

provisioningState: ProvisioningState

The provisioning state of the resource. Possible values include: 'Succeeded', 'Updating', 'Deleting', 'Failed'

serializedName

serializedName: string = "P2SVpnGateway"

Optional tags

tags: undefined | object

Resource tags.

Optional virtualHub

virtualHub: SubResource

The VirtualHub to which the gateway belongs.

Optional vpnClientAddressPool

vpnClientAddressPool: AddressSpace

The reference of the address space resource which represents Address space for P2S VpnClient.

Optional vpnClientConnectionHealth

vpnClientConnectionHealth: VpnClientConnectionHealth

All P2S VPN clients' connection health status. NOTE: This property will not be serialized. It can only be populated by the server.

Optional vpnGatewayScaleUnit

vpnGatewayScaleUnit: undefined | number

The scale unit for this p2s vpn gateway.

type

type: object

className

className: string = "P2SVpnGateway"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

customRoutes

customRoutes: object

serializedName

serializedName: string = "properties.customRoutes"

type

type: object

className

className: string = "AddressSpace"

name

name: "Composite" = "Composite"

etag

etag: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

p2SVpnServerConfiguration

p2SVpnServerConfiguration: object

serializedName

serializedName: string = "properties.p2SVpnServerConfiguration"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

virtualHub

virtualHub: object

serializedName

serializedName: string = "properties.virtualHub"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

vpnClientAddressPool

vpnClientAddressPool: object

serializedName

serializedName: string = "properties.vpnClientAddressPool"

type

type: object

className

className: string = "AddressSpace"

name

name: "Composite" = "Composite"

vpnClientConnectionHealth

vpnClientConnectionHealth: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.vpnClientConnectionHealth"

type

type: object

className

className: string = "VpnClientConnectionHealth"

name

name: "Composite" = "Composite"

vpnGatewayScaleUnit

vpnGatewayScaleUnit: object

serializedName

serializedName: string = "properties.vpnGatewayScaleUnit"

type

type: object

name

name: "Number" = "Number"

Const P2SVpnProfileParameters

P2SVpnProfileParameters: object

Vpn Client Parameters for package generation.

Optional authenticationMethod

authenticationMethod: AuthenticationMethod

VPN client authentication method. Possible values include: 'EAPTLS', 'EAPMSCHAPv2'

serializedName

serializedName: string = "P2SVpnProfileParameters"

type

type: object

className

className: string = "P2SVpnProfileParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

authenticationMethod

authenticationMethod: object

serializedName

serializedName: string = "authenticationMethod"

type

type: object

name

name: "String" = "String"

Const P2SVpnServerConfigRadiusClientRootCertificate

P2SVpnServerConfigRadiusClientRootCertificate: object

Radius client root certificate of P2SVpnServerConfiguration.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the Radius client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "P2SVpnServerConfigRadiusClientRootCertificate"

Optional thumbprint

thumbprint: undefined | string

The Radius client root certificate thumbprint.

type

type: object

className

className: string = "P2SVpnServerConfigRadiusClientRootCertificate"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

thumbprint

thumbprint: object

serializedName

serializedName: string = "properties.thumbprint"

type

type: object

name

name: "String" = "String"

Const P2SVpnServerConfigRadiusServerRootCertificate

P2SVpnServerConfigRadiusServerRootCertificate: object

Radius Server root certificate of P2SVpnServerConfiguration.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the P2SVpnServerConfiguration Radius Server root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. NOTE: This property will not be serialized. It can only be populated by the server.

publicCertData

publicCertData: string

The certificate public data.

serializedName

serializedName: string = "P2SVpnServerConfigRadiusServerRootCertificate"

type

type: object

className

className: string = "P2SVpnServerConfigRadiusServerRootCertificate"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

publicCertData

publicCertData: object

required

required: true = true

serializedName

serializedName: string = "properties.publicCertData"

type

type: object

name

name: "String" = "String"

Const P2SVpnServerConfigVpnClientRevokedCertificate

P2SVpnServerConfigVpnClientRevokedCertificate: object

VPN client revoked certificate of P2SVpnServerConfiguration.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "P2SVpnServerConfigVpnClientRevokedCertificate"

Optional thumbprint

thumbprint: undefined | string

The revoked VPN client certificate thumbprint.

type

type: object

className

className: string = "P2SVpnServerConfigVpnClientRevokedCertificate"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

thumbprint

thumbprint: object

serializedName

serializedName: string = "properties.thumbprint"

type

type: object

name

name: "String" = "String"

Const P2SVpnServerConfigVpnClientRootCertificate

P2SVpnServerConfigVpnClientRootCertificate: object

VPN client root certificate of P2SVpnServerConfiguration.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the P2SVpnServerConfiguration VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. NOTE: This property will not be serialized. It can only be populated by the server.

publicCertData

publicCertData: string

The certificate public data.

serializedName

serializedName: string = "P2SVpnServerConfigVpnClientRootCertificate"

type

type: object

className

className: string = "P2SVpnServerConfigVpnClientRootCertificate"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

publicCertData

publicCertData: object

required

required: true = true

serializedName

serializedName: string = "properties.publicCertData"

type

type: object

name

name: "String" = "String"

Const P2SVpnServerConfiguration

P2SVpnServerConfiguration: object

P2SVpnServerConfiguration Resource.

Optional etag

etag: undefined | string

Gets a unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional p2SVpnGateways

p2SVpnGateways: SubResource[]

List of references to P2SVpnGateways. NOTE: This property will not be serialized. It can only be populated by the server.

Optional p2SVpnServerConfigRadiusClientRootCertificates

p2SVpnServerConfigRadiusClientRootCertificates: P2SVpnServerConfigRadiusClientRootCertificate[]

Radius client root certificate of P2SVpnServerConfiguration.

Optional p2SVpnServerConfigRadiusServerRootCertificates

p2SVpnServerConfigRadiusServerRootCertificates: P2SVpnServerConfigRadiusServerRootCertificate[]

Radius Server root certificate of P2SVpnServerConfiguration.

Optional p2SVpnServerConfigVpnClientRevokedCertificates

p2SVpnServerConfigVpnClientRevokedCertificates: P2SVpnServerConfigVpnClientRevokedCertificate[]

VPN client revoked certificate of P2SVpnServerConfiguration.

Optional p2SVpnServerConfigVpnClientRootCertificates

p2SVpnServerConfigVpnClientRootCertificates: P2SVpnServerConfigVpnClientRootCertificate[]

VPN client root certificate of P2SVpnServerConfiguration.

Optional p2SVpnServerConfigurationPropertiesEtag

p2SVpnServerConfigurationPropertiesEtag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional p2SVpnServerConfigurationPropertiesName

p2SVpnServerConfigurationPropertiesName: undefined | string

The name of the P2SVpnServerConfiguration that is unique within a VirtualWan in a resource group. This name can be used to access the resource along with Paren VirtualWan resource name.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the P2SVpnServerConfiguration resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. NOTE: This property will not be serialized. It can only be populated by the server.

Optional radiusServerAddress

radiusServerAddress: undefined | string

The radius server address property of the P2SVpnServerConfiguration resource for point to site client connection.

Optional radiusServerSecret

radiusServerSecret: undefined | string

The radius secret property of the P2SVpnServerConfiguration resource for point to site client connection.

serializedName

serializedName: string = "P2SVpnServerConfiguration"

Optional vpnClientIpsecPolicies

vpnClientIpsecPolicies: IpsecPolicy[]

VpnClientIpsecPolicies for P2SVpnServerConfiguration.

Optional vpnProtocols

VPN protocols for the P2SVpnServerConfiguration.

type

type: object

className

className: string = "P2SVpnServerConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

etag

etag: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

p2SVpnGateways

p2SVpnGateways: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.p2SVpnGateways"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

p2SVpnServerConfigRadiusClientRootCertificates

p2SVpnServerConfigRadiusClientRootCertificates: object

serializedName

serializedName: string = "properties.p2SVpnServerConfigRadiusClientRootCertificates"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "P2SVpnServerConfigRadiusClientRootCertificate"

name

name: "Composite" = "Composite"

p2SVpnServerConfigRadiusServerRootCertificates

p2SVpnServerConfigRadiusServerRootCertificates: object

serializedName

serializedName: string = "properties.p2SVpnServerConfigRadiusServerRootCertificates"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "P2SVpnServerConfigRadiusServerRootCertificate"

name

name: "Composite" = "Composite"

p2SVpnServerConfigVpnClientRevokedCertificates

p2SVpnServerConfigVpnClientRevokedCertificates: object

serializedName

serializedName: string = "properties.p2SVpnServerConfigVpnClientRevokedCertificates"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "P2SVpnServerConfigVpnClientRevokedCertificate"

name

name: "Composite" = "Composite"

p2SVpnServerConfigVpnClientRootCertificates

p2SVpnServerConfigVpnClientRootCertificates: object

serializedName

serializedName: string = "properties.p2SVpnServerConfigVpnClientRootCertificates"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "P2SVpnServerConfigVpnClientRootCertificate"

name

name: "Composite" = "Composite"

p2SVpnServerConfigurationPropertiesEtag

p2SVpnServerConfigurationPropertiesEtag: object

serializedName

serializedName: string = "properties.etag"

type

type: object

name

name: "String" = "String"

p2SVpnServerConfigurationPropertiesName

p2SVpnServerConfigurationPropertiesName: object

serializedName

serializedName: string = "properties.name"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

radiusServerAddress

radiusServerAddress: object

serializedName

serializedName: string = "properties.radiusServerAddress"

type

type: object

name

name: "String" = "String"

radiusServerSecret

radiusServerSecret: object

serializedName

serializedName: string = "properties.radiusServerSecret"

type

type: object

name

name: "String" = "String"

vpnClientIpsecPolicies

vpnClientIpsecPolicies: object

serializedName

serializedName: string = "properties.vpnClientIpsecPolicies"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "IpsecPolicy"

name

name: "Composite" = "Composite"

vpnProtocols

vpnProtocols: object

serializedName

serializedName: string = "properties.vpnProtocols"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const PacketCapture

PacketCapture: object

Parameters that define the create packet capture operation.

Optional bytesToCapturePerPacket

bytesToCapturePerPacket: undefined | number

Number of bytes captured per packet, the remaining bytes are truncated. Default value: 0.

Optional filters

filters: PacketCaptureFilter[]

A list of packet capture filters.

serializedName

serializedName: string = "PacketCapture"

storageLocation

storageLocation: PacketCaptureStorageLocation

Describes the storage location for a packet capture session.

target

target: string

The ID of the targeted resource, only VM is currently supported.

Optional timeLimitInSeconds

timeLimitInSeconds: undefined | number

Maximum duration of the capture session in seconds. Default value: 18000.

Optional totalBytesPerSession

totalBytesPerSession: undefined | number

Maximum size of the capture output. Default value: 1073741824.

type

type: object

className

className: string = "PacketCapture"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

bytesToCapturePerPacket

bytesToCapturePerPacket: object

defaultValue

defaultValue: number = 0

serializedName

serializedName: string = "properties.bytesToCapturePerPacket"

type

type: object

name

name: "Number" = "Number"

filters

filters: object

serializedName

serializedName: string = "properties.filters"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PacketCaptureFilter"

name

name: "Composite" = "Composite"

storageLocation

storageLocation: object

required

required: true = true

serializedName

serializedName: string = "properties.storageLocation"

type

type: object

className

className: string = "PacketCaptureStorageLocation"

name

name: "Composite" = "Composite"

target

target: object

required

required: true = true

serializedName

serializedName: string = "properties.target"

type

type: object

name

name: "String" = "String"

timeLimitInSeconds

timeLimitInSeconds: object

defaultValue

defaultValue: number = 18000

serializedName

serializedName: string = "properties.timeLimitInSeconds"

type

type: object

name

name: "Number" = "Number"

totalBytesPerSession

totalBytesPerSession: object

defaultValue

defaultValue: number = 1073741824

serializedName

serializedName: string = "properties.totalBytesPerSession"

type

type: object

name

name: "Number" = "Number"

Const PacketCaptureFilter

PacketCaptureFilter: object

Filter that is applied to packet capture request. Multiple filters can be applied.

Optional localIPAddress

localIPAddress: undefined | string

Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for range. "127.0.0.1;127.0.0.5"? for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.

Optional localPort

localPort: undefined | string

Local port to be filtered on. Notation: "80" for single port entry."80-85" for range. "80;443;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.

Optional protocol

protocol: PcProtocol

Protocol to be filtered on. Possible values include: 'TCP', 'UDP', 'Any'. Default value: 'Any'.

Optional remoteIPAddress

remoteIPAddress: undefined | string

Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for range. "127.0.0.1;127.0.0.5;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.

Optional remotePort

remotePort: undefined | string

Remote port to be filtered on. Notation: "80" for single port entry."80-85" for range. "80;443;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.

serializedName

serializedName: string = "PacketCaptureFilter"

type

type: object

className

className: string = "PacketCaptureFilter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

localIPAddress

localIPAddress: object

serializedName

serializedName: string = "localIPAddress"

type

type: object

name

name: "String" = "String"

localPort

localPort: object

serializedName

serializedName: string = "localPort"

type

type: object

name

name: "String" = "String"

protocol

protocol: object

defaultValue

defaultValue: string = "Any"

serializedName

serializedName: string = "protocol"

type

type: object

name

name: "String" = "String"

remoteIPAddress

remoteIPAddress: object

serializedName

serializedName: string = "remoteIPAddress"

type

type: object

name

name: "String" = "String"

remotePort

remotePort: object

serializedName

serializedName: string = "remotePort"

type

type: object

name

name: "String" = "String"

Const PacketCaptureListResult

PacketCaptureListResult: object
interface

List of packet capture sessions.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "PacketCaptureListResult"

__@iterator

  • __@iterator(): IterableIterator<PacketCaptureResult>
  • Iterator

    Returns IterableIterator<PacketCaptureResult>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<PacketCaptureResult>[]): PacketCaptureResult[]
  • concat(...items: (T | ConcatArray<T>)[]): PacketCaptureResult[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<PacketCaptureResult>[]

      Additional items to add to the end of array1.

    Returns PacketCaptureResult[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns PacketCaptureResult[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, PacketCaptureResult]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, PacketCaptureResult]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: PacketCaptureResult, index: number, array: PacketCaptureResult[]): boolean
        • Parameters

          • value: PacketCaptureResult
          • index: number
          • array: PacketCaptureResult[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: PacketCaptureResult, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: PacketCaptureResult

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): PacketCaptureResult[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: PacketCaptureResult

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: PacketCaptureResult, index: number, array: PacketCaptureResult[]): boolean
        • Parameters

          • value: PacketCaptureResult
          • index: number
          • array: PacketCaptureResult[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: PacketCaptureResult, index: number, array: PacketCaptureResult[]): any
        • Parameters

          • value: PacketCaptureResult
          • index: number
          • array: PacketCaptureResult[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns PacketCaptureResult[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): PacketCaptureResult | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: PacketCaptureResult

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: PacketCaptureResult, index: number, obj: PacketCaptureResult[]): boolean
        • Parameters

          • this: void
          • value: PacketCaptureResult
          • index: number
          • obj: PacketCaptureResult[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: PacketCaptureResult, index: number, obj: PacketCaptureResult[]): boolean
        • Parameters

          • value: PacketCaptureResult
          • index: number
          • obj: PacketCaptureResult[]

          Returns boolean

    • Optional thisArg: any

    Returns PacketCaptureResult | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: PacketCaptureResult, index: number, obj: PacketCaptureResult[]): boolean
        • Parameters

          • value: PacketCaptureResult
          • index: number
          • obj: PacketCaptureResult[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: PacketCaptureResult, index: number, array: PacketCaptureResult[]): void
        • Parameters

          • value: PacketCaptureResult
          • index: number
          • array: PacketCaptureResult[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: PacketCaptureResult, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: PacketCaptureResult

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: PacketCaptureResult, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: PacketCaptureResult

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: PacketCaptureResult, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: PacketCaptureResult

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: PacketCaptureResult, index: number, array: PacketCaptureResult[]): U
        • Parameters

          • value: PacketCaptureResult
          • index: number
          • array: PacketCaptureResult[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): PacketCaptureResult | undefined
  • Removes the last element from an array and returns it.

    Returns PacketCaptureResult | undefined

push

  • push(...items: PacketCaptureResult[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: PacketCaptureResult[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): PacketCaptureResult
  • reduce(callbackfn: function, initialValue: PacketCaptureResult): PacketCaptureResult
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: PacketCaptureResult, currentValue: PacketCaptureResult, currentIndex: number, array: PacketCaptureResult[]): PacketCaptureResult
        • Parameters

          • previousValue: PacketCaptureResult
          • currentValue: PacketCaptureResult
          • currentIndex: number
          • array: PacketCaptureResult[]

          Returns PacketCaptureResult

    Returns PacketCaptureResult

  • Parameters

    • callbackfn: function
        • (previousValue: PacketCaptureResult, currentValue: PacketCaptureResult, currentIndex: number, array: PacketCaptureResult[]): PacketCaptureResult
        • Parameters

          • previousValue: PacketCaptureResult
          • currentValue: PacketCaptureResult
          • currentIndex: number
          • array: PacketCaptureResult[]

          Returns PacketCaptureResult

    • initialValue: PacketCaptureResult

    Returns PacketCaptureResult

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: PacketCaptureResult, currentIndex: number, array: PacketCaptureResult[]): U
        • Parameters

          • previousValue: U
          • currentValue: PacketCaptureResult
          • currentIndex: number
          • array: PacketCaptureResult[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): PacketCaptureResult
  • reduceRight(callbackfn: function, initialValue: PacketCaptureResult): PacketCaptureResult
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: PacketCaptureResult, currentValue: PacketCaptureResult, currentIndex: number, array: PacketCaptureResult[]): PacketCaptureResult
        • Parameters

          • previousValue: PacketCaptureResult
          • currentValue: PacketCaptureResult
          • currentIndex: number
          • array: PacketCaptureResult[]

          Returns PacketCaptureResult

    Returns PacketCaptureResult

  • Parameters

    • callbackfn: function
        • (previousValue: PacketCaptureResult, currentValue: PacketCaptureResult, currentIndex: number, array: PacketCaptureResult[]): PacketCaptureResult
        • Parameters

          • previousValue: PacketCaptureResult
          • currentValue: PacketCaptureResult
          • currentIndex: number
          • array: PacketCaptureResult[]

          Returns PacketCaptureResult

    • initialValue: PacketCaptureResult

    Returns PacketCaptureResult

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: PacketCaptureResult, currentIndex: number, array: PacketCaptureResult[]): U
        • Parameters

          • previousValue: U
          • currentValue: PacketCaptureResult
          • currentIndex: number
          • array: PacketCaptureResult[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): PacketCaptureResult[]
  • Reverses the elements in an Array.

    Returns PacketCaptureResult[]

shift

  • shift(): PacketCaptureResult | undefined
  • Removes the first element from an array and returns it.

    Returns PacketCaptureResult | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): PacketCaptureResult[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns PacketCaptureResult[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: PacketCaptureResult, index: number, array: PacketCaptureResult[]): boolean
        • Parameters

          • value: PacketCaptureResult
          • index: number
          • array: PacketCaptureResult[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): PacketCaptureResult[]
  • splice(start: number, deleteCount: number, ...items: PacketCaptureResult[]): PacketCaptureResult[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns PacketCaptureResult[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: PacketCaptureResult[]

      Elements to insert into the array in place of the deleted elements.

    Returns PacketCaptureResult[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: PacketCaptureResult[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: PacketCaptureResult[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<PacketCaptureResult>
  • Returns an iterable of values in the array

    Returns IterableIterator<PacketCaptureResult>

type

type: object

className

className: string = "PacketCaptureListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PacketCaptureResult"

name

name: "Composite" = "Composite"

Const PacketCaptureParameters

PacketCaptureParameters: object

Parameters that define the create packet capture operation.

Optional bytesToCapturePerPacket

bytesToCapturePerPacket: undefined | number

Number of bytes captured per packet, the remaining bytes are truncated. Default value: 0.

Optional filters

filters: PacketCaptureFilter[]

A list of packet capture filters.

serializedName

serializedName: string = "PacketCaptureParameters"

storageLocation

storageLocation: PacketCaptureStorageLocation

Describes the storage location for a packet capture session.

target

target: string

The ID of the targeted resource, only VM is currently supported.

Optional timeLimitInSeconds

timeLimitInSeconds: undefined | number

Maximum duration of the capture session in seconds. Default value: 18000.

Optional totalBytesPerSession

totalBytesPerSession: undefined | number

Maximum size of the capture output. Default value: 1073741824.

type

type: object

className

className: string = "PacketCaptureParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

bytesToCapturePerPacket

bytesToCapturePerPacket: object

defaultValue

defaultValue: number = 0

serializedName

serializedName: string = "bytesToCapturePerPacket"

type

type: object

name

name: "Number" = "Number"

filters

filters: object

serializedName

serializedName: string = "filters"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PacketCaptureFilter"

name

name: "Composite" = "Composite"

storageLocation

storageLocation: object

required

required: true = true

serializedName

serializedName: string = "storageLocation"

type

type: object

className

className: string = "PacketCaptureStorageLocation"

name

name: "Composite" = "Composite"

target

target: object

required

required: true = true

serializedName

serializedName: string = "target"

type

type: object

name

name: "String" = "String"

timeLimitInSeconds

timeLimitInSeconds: object

defaultValue

defaultValue: number = 18000

serializedName

serializedName: string = "timeLimitInSeconds"

type

type: object

name

name: "Number" = "Number"

totalBytesPerSession

totalBytesPerSession: object

defaultValue

defaultValue: number = 1073741824

serializedName

serializedName: string = "totalBytesPerSession"

type

type: object

name

name: "Number" = "Number"

Const PacketCaptureQueryStatusResult

PacketCaptureQueryStatusResult: object

Status of packet capture session.

Optional captureStartTime

captureStartTime: Date

The start time of the packet capture session.

Optional id

id: undefined | string

The ID of the packet capture resource.

Optional name

name: undefined | string

The name of the packet capture resource.

Optional packetCaptureError

packetCaptureError: PcError[]

List of errors of packet capture session.

Optional packetCaptureStatus

packetCaptureStatus: PcStatus

The status of the packet capture session. Possible values include: 'NotStarted', 'Running', 'Stopped', 'Error', 'Unknown'

serializedName

serializedName: string = "PacketCaptureQueryStatusResult"

Optional stopReason

stopReason: undefined | string

The reason the current packet capture session was stopped.

type

type: object

className

className: string = "PacketCaptureQueryStatusResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

captureStartTime

captureStartTime: object

serializedName

serializedName: string = "captureStartTime"

type

type: object

name

name: "DateTime" = "DateTime"

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

packetCaptureError

packetCaptureError: object

serializedName

serializedName: string = "packetCaptureError"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

packetCaptureStatus

packetCaptureStatus: object

serializedName

serializedName: string = "packetCaptureStatus"

type

type: object

name

name: "String" = "String"

stopReason

stopReason: object

serializedName

serializedName: string = "stopReason"

type

type: object

name

name: "String" = "String"

Const PacketCaptureResult

PacketCaptureResult: object

Information about packet capture session.

Optional bytesToCapturePerPacket

bytesToCapturePerPacket: undefined | number

Number of bytes captured per packet, the remaining bytes are truncated. Default value: 0.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated. Default value: 'A unique read-only string that changes whenever the resource is updated.'.

Optional filters

filters: PacketCaptureFilter[]

A list of packet capture filters.

Optional id

id: undefined | string

ID of the packet capture operation. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Name of the packet capture session. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: ProvisioningState

The provisioning state of the packet capture session. Possible values include: 'Succeeded', 'Updating', 'Deleting', 'Failed'

serializedName

serializedName: string = "PacketCaptureResult"

storageLocation

storageLocation: PacketCaptureStorageLocation

Describes the storage location for a packet capture session.

target

target: string

The ID of the targeted resource, only VM is currently supported.

Optional timeLimitInSeconds

timeLimitInSeconds: undefined | number

Maximum duration of the capture session in seconds. Default value: 18000.

Optional totalBytesPerSession

totalBytesPerSession: undefined | number

Maximum size of the capture output. Default value: 1073741824.

type

type: object

className

className: string = "PacketCaptureResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

bytesToCapturePerPacket

bytesToCapturePerPacket: object

defaultValue

defaultValue: number = 0

serializedName

serializedName: string = "properties.bytesToCapturePerPacket"

type

type: object

name

name: "Number" = "Number"

etag

etag: object

defaultValue

defaultValue: string = "A unique read-only string that changes whenever the resource is updated."

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

filters

filters: object

serializedName

serializedName: string = "properties.filters"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PacketCaptureFilter"

name

name: "Composite" = "Composite"

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

storageLocation

storageLocation: object

required

required: true = true

serializedName

serializedName: string = "properties.storageLocation"

type

type: object

className

className: string = "PacketCaptureStorageLocation"

name

name: "Composite" = "Composite"

target

target: object

required

required: true = true

serializedName

serializedName: string = "properties.target"

type

type: object

name

name: "String" = "String"

timeLimitInSeconds

timeLimitInSeconds: object

defaultValue

defaultValue: number = 18000

serializedName

serializedName: string = "properties.timeLimitInSeconds"

type

type: object

name

name: "Number" = "Number"

totalBytesPerSession

totalBytesPerSession: object

defaultValue

defaultValue: number = 1073741824

serializedName

serializedName: string = "properties.totalBytesPerSession"

type

type: object

name

name: "Number" = "Number"

Const PacketCaptureStorageLocation

PacketCaptureStorageLocation: object

Describes the storage location for a packet capture session.

Optional filePath

filePath: undefined | string

A valid local path on the targeting VM. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures. Required if no storage ID is provided, otherwise optional.

serializedName

serializedName: string = "PacketCaptureStorageLocation"

Optional storageId

storageId: undefined | string

The ID of the storage account to save the packet capture session. Required if no local file path is provided.

Optional storagePath

storagePath: undefined | string

The URI of the storage path to save the packet capture. Must be a well-formed URI describing the location to save the packet capture.

type

type: object

className

className: string = "PacketCaptureStorageLocation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

filePath

filePath: object

serializedName

serializedName: string = "filePath"

type

type: object

name

name: "String" = "String"

storageId

storageId: object

serializedName

serializedName: string = "storageId"

type

type: object

name

name: "String" = "String"

storagePath

storagePath: object

serializedName

serializedName: string = "storagePath"

type

type: object

name

name: "String" = "String"

Const PatchRouteFilter

PatchRouteFilter: object

Route Filter Resource.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID.

Optional ipv6Peerings

ipv6Peerings: ExpressRouteCircuitPeering[]

A collection of references to express route circuit ipv6 peerings.

Optional name

name: undefined | string

The name of the resource that is unique within a resource group. This name can be used to access the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional peerings

peerings: ExpressRouteCircuitPeering[]

A collection of references to express route circuit peerings.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. NOTE: This property will not be serialized. It can only be populated by the server.

Optional rules

rules: RouteFilterRule[]

Collection of RouteFilterRules contained within a route filter.

serializedName

serializedName: string = "PatchRouteFilter"

Optional tags

tags: undefined | object

Resource tags.

type

type: object

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "PatchRouteFilter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

etag

etag: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

ipv6Peerings

ipv6Peerings: object

serializedName

serializedName: string = "properties.ipv6Peerings"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ExpressRouteCircuitPeering"

name

name: "Composite" = "Composite"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

peerings

peerings: object

serializedName

serializedName: string = "properties.peerings"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ExpressRouteCircuitPeering"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

rules

rules: object

serializedName

serializedName: string = "properties.rules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RouteFilterRule"

name

name: "Composite" = "Composite"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const PatchRouteFilterRule

PatchRouteFilterRule: object

Route Filter Rule Resource.

access

access: Access

The access type of the rule. Possible values include: 'Allow', 'Deny'

communities

communities: string[]

The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'].

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

The name of the resource that is unique within a resource group. This name can be used to access the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "PatchRouteFilterRule"

type

type: object

className

className: string = "PatchRouteFilterRule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

access

access: object

required

required: true = true

serializedName

serializedName: string = "properties.access"

type

type: object

name

name: "String" = "String"

communities

communities: object

required

required: true = true

serializedName

serializedName: string = "properties.communities"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

etag

etag: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

routeFilterRuleType

routeFilterRuleType: object

defaultValue

defaultValue: string = "Community"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "properties.routeFilterRuleType"

type

type: object

name

name: "String" = "String"

Const PeerExpressRouteCircuitConnection

PeerExpressRouteCircuitConnection: object

Peer Express Route Circuit Connection in an ExpressRouteCircuitPeering resource.

Optional addressPrefix

addressPrefix: undefined | string

/29 IP address space to carve out Customer addresses for tunnels.

Optional authResourceGuid

authResourceGuid: undefined | string

The resource guid of the authorization used for the express route circuit connection.

Optional circuitConnectionStatus

circuitConnectionStatus: CircuitConnectionStatus

Express Route Circuit connection state. Possible values include: 'Connected', 'Connecting', 'Disconnected'

Optional connectionName

connectionName: undefined | string

The name of the express route circuit connection resource.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

Optional expressRouteCircuitPeering

expressRouteCircuitPeering: SubResource

Reference to Express Route Circuit Private Peering Resource of the circuit.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

Gets name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional peerExpressRouteCircuitPeering

peerExpressRouteCircuitPeering: SubResource

Reference to Express Route Circuit Private Peering Resource of the peered circuit.

Optional provisioningState

provisioningState: undefined | string

Provisioning state of the peer express route circuit connection resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "PeerExpressRouteCircuitConnection"

type

type: object

Type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "PeerExpressRouteCircuitConnection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

addressPrefix

addressPrefix: object

serializedName

serializedName: string = "properties.addressPrefix"

type

type: object

name

name: "String" = "String"

authResourceGuid

authResourceGuid: object

serializedName

serializedName: string = "properties.authResourceGuid"

type

type: object

name

name: "String" = "String"

circuitConnectionStatus

circuitConnectionStatus: object

serializedName

serializedName: string = "properties.circuitConnectionStatus"

type

type: object

name

name: "String" = "String"

connectionName

connectionName: object

serializedName

serializedName: string = "properties.connectionName"

type

type: object

name

name: "String" = "String"

etag

etag: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

expressRouteCircuitPeering

expressRouteCircuitPeering: object

serializedName

serializedName: string = "properties.expressRouteCircuitPeering"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

peerExpressRouteCircuitPeering

peerExpressRouteCircuitPeering: object

serializedName

serializedName: string = "properties.peerExpressRouteCircuitPeering"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const PeerExpressRouteCircuitConnectionListResult

PeerExpressRouteCircuitConnectionListResult: object
interface

Response for ListPeeredConnections API service call retrieves all global reach peer circuit connections that belongs to a Private Peering for an ExpressRouteCircuit.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "PeerExpressRouteCircuitConnectionListResult"

__@iterator

  • __@iterator(): IterableIterator<PeerExpressRouteCircuitConnection>
  • Iterator

    Returns IterableIterator<PeerExpressRouteCircuitConnection>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<PeerExpressRouteCircuitConnection>[]): PeerExpressRouteCircuitConnection[]
  • concat(...items: (T | ConcatArray<T>)[]): PeerExpressRouteCircuitConnection[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<PeerExpressRouteCircuitConnection>[]

      Additional items to add to the end of array1.

    Returns PeerExpressRouteCircuitConnection[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns PeerExpressRouteCircuitConnection[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, PeerExpressRouteCircuitConnection]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, PeerExpressRouteCircuitConnection]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: PeerExpressRouteCircuitConnection, index: number, array: PeerExpressRouteCircuitConnection[]): boolean
        • Parameters

          • value: PeerExpressRouteCircuitConnection
          • index: number
          • array: PeerExpressRouteCircuitConnection[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: PeerExpressRouteCircuitConnection, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: PeerExpressRouteCircuitConnection

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): PeerExpressRouteCircuitConnection[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: PeerExpressRouteCircuitConnection

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: PeerExpressRouteCircuitConnection, index: number, array: PeerExpressRouteCircuitConnection[]): boolean
        • Parameters

          • value: PeerExpressRouteCircuitConnection
          • index: number
          • array: PeerExpressRouteCircuitConnection[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: PeerExpressRouteCircuitConnection, index: number, array: PeerExpressRouteCircuitConnection[]): any
        • Parameters

          • value: PeerExpressRouteCircuitConnection
          • index: number
          • array: PeerExpressRouteCircuitConnection[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns PeerExpressRouteCircuitConnection[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): PeerExpressRouteCircuitConnection | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: PeerExpressRouteCircuitConnection

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: PeerExpressRouteCircuitConnection, index: number, obj: PeerExpressRouteCircuitConnection[]): boolean
        • Parameters

          • this: void
          • value: PeerExpressRouteCircuitConnection
          • index: number
          • obj: PeerExpressRouteCircuitConnection[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: PeerExpressRouteCircuitConnection, index: number, obj: PeerExpressRouteCircuitConnection[]): boolean
        • Parameters

          • value: PeerExpressRouteCircuitConnection
          • index: number
          • obj: PeerExpressRouteCircuitConnection[]

          Returns boolean

    • Optional thisArg: any

    Returns PeerExpressRouteCircuitConnection | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: PeerExpressRouteCircuitConnection, index: number, obj: PeerExpressRouteCircuitConnection[]): boolean
        • Parameters

          • value: PeerExpressRouteCircuitConnection
          • index: number
          • obj: PeerExpressRouteCircuitConnection[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: PeerExpressRouteCircuitConnection, index: number, array: PeerExpressRouteCircuitConnection[]): void
        • Parameters

          • value: PeerExpressRouteCircuitConnection
          • index: number
          • array: PeerExpressRouteCircuitConnection[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: PeerExpressRouteCircuitConnection, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: PeerExpressRouteCircuitConnection

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: PeerExpressRouteCircuitConnection, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: PeerExpressRouteCircuitConnection

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: PeerExpressRouteCircuitConnection, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: PeerExpressRouteCircuitConnection

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: PeerExpressRouteCircuitConnection, index: number, array: PeerExpressRouteCircuitConnection[]): U
        • Parameters

          • value: PeerExpressRouteCircuitConnection
          • index: number
          • array: PeerExpressRouteCircuitConnection[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): PeerExpressRouteCircuitConnection | undefined
  • Removes the last element from an array and returns it.

    Returns PeerExpressRouteCircuitConnection | undefined

push

  • push(...items: PeerExpressRouteCircuitConnection[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: PeerExpressRouteCircuitConnection[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): PeerExpressRouteCircuitConnection
  • reduce(callbackfn: function, initialValue: PeerExpressRouteCircuitConnection): PeerExpressRouteCircuitConnection
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: PeerExpressRouteCircuitConnection, currentValue: PeerExpressRouteCircuitConnection, currentIndex: number, array: PeerExpressRouteCircuitConnection[]): PeerExpressRouteCircuitConnection
        • Parameters

          • previousValue: PeerExpressRouteCircuitConnection
          • currentValue: PeerExpressRouteCircuitConnection
          • currentIndex: number
          • array: PeerExpressRouteCircuitConnection[]

          Returns PeerExpressRouteCircuitConnection

    Returns PeerExpressRouteCircuitConnection

  • Parameters

    • callbackfn: function
        • (previousValue: PeerExpressRouteCircuitConnection, currentValue: PeerExpressRouteCircuitConnection, currentIndex: number, array: PeerExpressRouteCircuitConnection[]): PeerExpressRouteCircuitConnection
        • Parameters

          • previousValue: PeerExpressRouteCircuitConnection
          • currentValue: PeerExpressRouteCircuitConnection
          • currentIndex: number
          • array: PeerExpressRouteCircuitConnection[]

          Returns PeerExpressRouteCircuitConnection

    • initialValue: PeerExpressRouteCircuitConnection

    Returns PeerExpressRouteCircuitConnection

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: PeerExpressRouteCircuitConnection, currentIndex: number, array: PeerExpressRouteCircuitConnection[]): U
        • Parameters

          • previousValue: U
          • currentValue: PeerExpressRouteCircuitConnection
          • currentIndex: number
          • array: PeerExpressRouteCircuitConnection[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): PeerExpressRouteCircuitConnection
  • reduceRight(callbackfn: function, initialValue: PeerExpressRouteCircuitConnection): PeerExpressRouteCircuitConnection
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: PeerExpressRouteCircuitConnection, currentValue: PeerExpressRouteCircuitConnection, currentIndex: number, array: PeerExpressRouteCircuitConnection[]): PeerExpressRouteCircuitConnection
        • Parameters

          • previousValue: PeerExpressRouteCircuitConnection
          • currentValue: PeerExpressRouteCircuitConnection
          • currentIndex: number
          • array: PeerExpressRouteCircuitConnection[]

          Returns PeerExpressRouteCircuitConnection

    Returns PeerExpressRouteCircuitConnection

  • Parameters

    • callbackfn: function
        • (previousValue: PeerExpressRouteCircuitConnection, currentValue: PeerExpressRouteCircuitConnection, currentIndex: number, array: PeerExpressRouteCircuitConnection[]): PeerExpressRouteCircuitConnection
        • Parameters

          • previousValue: PeerExpressRouteCircuitConnection
          • currentValue: PeerExpressRouteCircuitConnection
          • currentIndex: number
          • array: PeerExpressRouteCircuitConnection[]

          Returns PeerExpressRouteCircuitConnection

    • initialValue: PeerExpressRouteCircuitConnection

    Returns PeerExpressRouteCircuitConnection

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: PeerExpressRouteCircuitConnection, currentIndex: number, array: PeerExpressRouteCircuitConnection[]): U
        • Parameters

          • previousValue: U
          • currentValue: PeerExpressRouteCircuitConnection
          • currentIndex: number
          • array: PeerExpressRouteCircuitConnection[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): PeerExpressRouteCircuitConnection[]
  • Reverses the elements in an Array.

    Returns PeerExpressRouteCircuitConnection[]

shift

  • shift(): PeerExpressRouteCircuitConnection | undefined
  • Removes the first element from an array and returns it.

    Returns PeerExpressRouteCircuitConnection | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): PeerExpressRouteCircuitConnection[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns PeerExpressRouteCircuitConnection[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: PeerExpressRouteCircuitConnection, index: number, array: PeerExpressRouteCircuitConnection[]): boolean
        • Parameters

          • value: PeerExpressRouteCircuitConnection
          • index: number
          • array: PeerExpressRouteCircuitConnection[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): PeerExpressRouteCircuitConnection[]
  • splice(start: number, deleteCount: number, ...items: PeerExpressRouteCircuitConnection[]): PeerExpressRouteCircuitConnection[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns PeerExpressRouteCircuitConnection[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: PeerExpressRouteCircuitConnection[]

      Elements to insert into the array in place of the deleted elements.

    Returns PeerExpressRouteCircuitConnection[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: PeerExpressRouteCircuitConnection[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: PeerExpressRouteCircuitConnection[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<PeerExpressRouteCircuitConnection>
  • Returns an iterable of values in the array

    Returns IterableIterator<PeerExpressRouteCircuitConnection>

type

type: object

className

className: string = "PeerExpressRouteCircuitConnectionListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PeerExpressRouteCircuitConnection"

name

name: "Composite" = "Composite"

Const PolicySettings

PolicySettings: object

Defines contents of a web application firewall global configuration.

Optional enabledState

Describes if the policy is in enabled state or disabled state. Possible values include: 'Disabled', 'Enabled'

Optional mode

Describes if it is in detection mode or prevention mode at policy level. Possible values include: 'Prevention', 'Detection'

serializedName

serializedName: string = "PolicySettings"

type

type: object

className

className: string = "PolicySettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

enabledState

enabledState: object

serializedName

serializedName: string = "enabledState"

type

type: object

name

name: "String" = "String"

mode

mode: object

serializedName

serializedName: string = "mode"

type

type: object

name

name: "String" = "String"

Const PrepareNetworkPoliciesRequest

PrepareNetworkPoliciesRequest: object

Details of PrepareNetworkPolicies for Subnet.

Optional networkIntentPolicyConfigurations

networkIntentPolicyConfigurations: NetworkIntentPolicyConfiguration[]

A list of NetworkIntentPolicyConfiguration.

Optional resourceGroupName

resourceGroupName: undefined | string

The name of the resource group where the Network Intent Policy will be stored.

serializedName

serializedName: string = "PrepareNetworkPoliciesRequest"

Optional serviceName

serviceName: undefined | string

The name of the service for which subnet is being prepared for.

type

type: object

className

className: string = "PrepareNetworkPoliciesRequest"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

networkIntentPolicyConfigurations

networkIntentPolicyConfigurations: object

serializedName

serializedName: string = "networkIntentPolicyConfigurations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NetworkIntentPolicyConfiguration"

name

name: "Composite" = "Composite"

resourceGroupName

resourceGroupName: object

serializedName

serializedName: string = "resourceGroupName"

type

type: object

name

name: "String" = "String"

serviceName

serviceName: object

serializedName

serializedName: string = "serviceName"

type

type: object

name

name: "String" = "String"

Const PrivateEndpoint

PrivateEndpoint: object

Private endpoint resource.

Optional etag

etag: undefined | string

Gets a unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional location

location: undefined | string

Resource location.

Optional manualPrivateLinkServiceConnections

manualPrivateLinkServiceConnections: PrivateLinkServiceConnection[]

A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional networkInterfaces

networkInterfaces: NetworkInterface[]

Gets an array of references to the network interfaces created for this private endpoint. NOTE: This property will not be serialized. It can only be populated by the server.

Optional privateLinkServiceConnections

privateLinkServiceConnections: PrivateLinkServiceConnection[]

A grouping of information about the connection to the remote resource.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the private endpoint. Possible values are: 'Updating', 'Deleting', and 'Failed'. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "PrivateEndpoint"

Optional subnet

subnet: Subnet

The ID of the subnet from which the private IP will be allocated.

Optional tags

tags: undefined | object

Resource tags.

type

type: object

className

className: string = "PrivateEndpoint"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

manualPrivateLinkServiceConnections

manualPrivateLinkServiceConnections: object

serializedName

serializedName: string = "properties.manualPrivateLinkServiceConnections"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PrivateLinkServiceConnection"

name

name: "Composite" = "Composite"

networkInterfaces

networkInterfaces: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.networkInterfaces"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NetworkInterface"

name

name: "Composite" = "Composite"

privateLinkServiceConnections

privateLinkServiceConnections: object

serializedName

serializedName: string = "properties.privateLinkServiceConnections"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PrivateLinkServiceConnection"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

subnet

subnet: object

serializedName

serializedName: string = "properties.subnet"

type

type: object

className

className: string = "Subnet"

name

name: "Composite" = "Composite"

Const PrivateEndpointConnection

PrivateEndpointConnection: object

PrivateEndpointConnection resource.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional privateEndpoint

privateEndpoint: PrivateEndpoint

The resource of private end point.

Optional privateLinkServiceConnectionState

privateLinkServiceConnectionState: PrivateLinkServiceConnectionState

A collection of information about the state of the connection between service consumer and provider.

serializedName

serializedName: string = "PrivateEndpointConnection"

type

type: object

className

className: string = "PrivateEndpointConnection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

privateEndpoint

privateEndpoint: object

serializedName

serializedName: string = "properties.privateEndpoint"

type

type: object

className

className: string = "PrivateEndpoint"

name

name: "Composite" = "Composite"

privateLinkServiceConnectionState

privateLinkServiceConnectionState: object

serializedName

serializedName: string = "properties.privateLinkServiceConnectionState"

type

type: object

className

className: string = "PrivateLinkServiceConnectionState"

name

name: "Composite" = "Composite"

Const PrivateEndpointListResult

PrivateEndpointListResult: object
interface

Response for the ListPrivateEndpoints API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "PrivateEndpointListResult"

__@iterator

  • __@iterator(): IterableIterator<PrivateEndpoint>
  • Iterator

    Returns IterableIterator<PrivateEndpoint>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<PrivateEndpoint>[]): PrivateEndpoint[]
  • concat(...items: (T | ConcatArray<T>)[]): PrivateEndpoint[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<PrivateEndpoint>[]

      Additional items to add to the end of array1.

    Returns PrivateEndpoint[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns PrivateEndpoint[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, PrivateEndpoint]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, PrivateEndpoint]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: PrivateEndpoint, index: number, array: PrivateEndpoint[]): boolean
        • Parameters

          • value: PrivateEndpoint
          • index: number
          • array: PrivateEndpoint[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: PrivateEndpoint, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: PrivateEndpoint

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): PrivateEndpoint[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: PrivateEndpoint

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: PrivateEndpoint, index: number, array: PrivateEndpoint[]): boolean
        • Parameters

          • value: PrivateEndpoint
          • index: number
          • array: PrivateEndpoint[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: PrivateEndpoint, index: number, array: PrivateEndpoint[]): any
        • Parameters

          • value: PrivateEndpoint
          • index: number
          • array: PrivateEndpoint[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns PrivateEndpoint[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): PrivateEndpoint | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: PrivateEndpoint

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: PrivateEndpoint, index: number, obj: PrivateEndpoint[]): boolean
        • Parameters

          • this: void
          • value: PrivateEndpoint
          • index: number
          • obj: PrivateEndpoint[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: PrivateEndpoint, index: number, obj: PrivateEndpoint[]): boolean
        • Parameters

          • value: PrivateEndpoint
          • index: number
          • obj: PrivateEndpoint[]

          Returns boolean

    • Optional thisArg: any

    Returns PrivateEndpoint | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: PrivateEndpoint, index: number, obj: PrivateEndpoint[]): boolean
        • Parameters

          • value: PrivateEndpoint
          • index: number
          • obj: PrivateEndpoint[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: PrivateEndpoint, index: number, array: PrivateEndpoint[]): void
        • Parameters

          • value: PrivateEndpoint
          • index: number
          • array: PrivateEndpoint[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: PrivateEndpoint, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: PrivateEndpoint

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: PrivateEndpoint, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: PrivateEndpoint

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: PrivateEndpoint, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: PrivateEndpoint

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: PrivateEndpoint, index: number, array: PrivateEndpoint[]): U
        • Parameters

          • value: PrivateEndpoint
          • index: number
          • array: PrivateEndpoint[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): PrivateEndpoint | undefined
  • Removes the last element from an array and returns it.

    Returns PrivateEndpoint | undefined

push

  • push(...items: PrivateEndpoint[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: PrivateEndpoint[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): PrivateEndpoint
  • reduce(callbackfn: function, initialValue: PrivateEndpoint): PrivateEndpoint
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: PrivateEndpoint, currentValue: PrivateEndpoint, currentIndex: number, array: PrivateEndpoint[]): PrivateEndpoint
        • Parameters

          • previousValue: PrivateEndpoint
          • currentValue: PrivateEndpoint
          • currentIndex: number
          • array: PrivateEndpoint[]

          Returns PrivateEndpoint

    Returns PrivateEndpoint

  • Parameters

    • callbackfn: function
        • (previousValue: PrivateEndpoint, currentValue: PrivateEndpoint, currentIndex: number, array: PrivateEndpoint[]): PrivateEndpoint
        • Parameters

          • previousValue: PrivateEndpoint
          • currentValue: PrivateEndpoint
          • currentIndex: number
          • array: PrivateEndpoint[]

          Returns PrivateEndpoint

    • initialValue: PrivateEndpoint

    Returns PrivateEndpoint

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: PrivateEndpoint, currentIndex: number, array: PrivateEndpoint[]): U
        • Parameters

          • previousValue: U
          • currentValue: PrivateEndpoint
          • currentIndex: number
          • array: PrivateEndpoint[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): PrivateEndpoint
  • reduceRight(callbackfn: function, initialValue: PrivateEndpoint): PrivateEndpoint
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: PrivateEndpoint, currentValue: PrivateEndpoint, currentIndex: number, array: PrivateEndpoint[]): PrivateEndpoint
        • Parameters

          • previousValue: PrivateEndpoint
          • currentValue: PrivateEndpoint
          • currentIndex: number
          • array: PrivateEndpoint[]

          Returns PrivateEndpoint

    Returns PrivateEndpoint

  • Parameters

    • callbackfn: function
        • (previousValue: PrivateEndpoint, currentValue: PrivateEndpoint, currentIndex: number, array: PrivateEndpoint[]): PrivateEndpoint
        • Parameters

          • previousValue: PrivateEndpoint
          • currentValue: PrivateEndpoint
          • currentIndex: number
          • array: PrivateEndpoint[]

          Returns PrivateEndpoint

    • initialValue: PrivateEndpoint

    Returns PrivateEndpoint

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: PrivateEndpoint, currentIndex: number, array: PrivateEndpoint[]): U
        • Parameters

          • previousValue: U
          • currentValue: PrivateEndpoint
          • currentIndex: number
          • array: PrivateEndpoint[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): PrivateEndpoint[]
  • Reverses the elements in an Array.

    Returns PrivateEndpoint[]

shift

  • shift(): PrivateEndpoint | undefined
  • Removes the first element from an array and returns it.

    Returns PrivateEndpoint | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): PrivateEndpoint[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns PrivateEndpoint[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: PrivateEndpoint, index: number, array: PrivateEndpoint[]): boolean
        • Parameters

          • value: PrivateEndpoint
          • index: number
          • array: PrivateEndpoint[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): PrivateEndpoint[]
  • splice(start: number, deleteCount: number, ...items: PrivateEndpoint[]): PrivateEndpoint[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns PrivateEndpoint[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: PrivateEndpoint[]

      Elements to insert into the array in place of the deleted elements.

    Returns PrivateEndpoint[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: PrivateEndpoint[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: PrivateEndpoint[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<PrivateEndpoint>
  • Returns an iterable of values in the array

    Returns IterableIterator<PrivateEndpoint>

type

type: object

className

className: string = "PrivateEndpointListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PrivateEndpoint"

name

name: "Composite" = "Composite"

Const PrivateLinkService

PrivateLinkService: object

Private link service resource.

Optional alias

alias: undefined | string

The alias of the private link service. NOTE: This property will not be serialized. It can only be populated by the server.

Optional autoApproval

The auto-approval list of the private link service.

Optional etag

etag: undefined | string

Gets a unique read-only string that changes whenever the resource is updated.

Optional fqdns

fqdns: string[]

The list of Fqdn.

Optional id

id: undefined | string

Resource ID.

Optional ipConfigurations

ipConfigurations: PrivateLinkServiceIpConfiguration[]

An array of references to the private link service IP configuration.

Optional loadBalancerFrontendIPConfigurations

loadBalancerFrontendIPConfigurations: FrontendIPConfiguration[]

An array of references to the load balancer IP configurations.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional networkInterfaces

networkInterfaces: NetworkInterface[]

Gets an array of references to the network interfaces created for this private link service. NOTE: This property will not be serialized. It can only be populated by the server.

Optional privateEndpointConnections

privateEndpointConnections: PrivateEndpointConnection[]

An array of list about connections to the private endpoint.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the private link service. Possible values are: 'Updating', 'Succeeded', and 'Failed'. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "PrivateLinkService"

Optional tags

tags: undefined | object

Resource tags.

Optional visibility

The visibility list of the private link service.

type

type: object

className

className: string = "PrivateLinkService"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

alias

alias: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.alias"

type

type: object

name

name: "String" = "String"

autoApproval

autoApproval: object

serializedName

serializedName: string = "properties.autoApproval"

type

type: object

className

className: string = "PrivateLinkServicePropertiesAutoApproval"

name

name: "Composite" = "Composite"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

fqdns

fqdns: object

serializedName

serializedName: string = "properties.fqdns"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

ipConfigurations

ipConfigurations: object

serializedName

serializedName: string = "properties.ipConfigurations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PrivateLinkServiceIpConfiguration"

name

name: "Composite" = "Composite"

loadBalancerFrontendIPConfigurations

loadBalancerFrontendIPConfigurations: object

serializedName

serializedName: string = "properties.loadBalancerFrontendIPConfigurations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "FrontendIPConfiguration"

name

name: "Composite" = "Composite"

networkInterfaces

networkInterfaces: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.networkInterfaces"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NetworkInterface"

name

name: "Composite" = "Composite"

privateEndpointConnections

privateEndpointConnections: object

serializedName

serializedName: string = "properties.privateEndpointConnections"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PrivateEndpointConnection"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

visibility

visibility: object

serializedName

serializedName: string = "properties.visibility"

type

type: object

className

className: string = "PrivateLinkServicePropertiesVisibility"

name

name: "Composite" = "Composite"

Const PrivateLinkServiceConnection

PrivateLinkServiceConnection: object

PrivateLinkServiceConnection resource.

Optional groupIds

groupIds: string[]

The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional privateLinkServiceConnectionState

privateLinkServiceConnectionState: PrivateLinkServiceConnectionState

A collection of read-only information about the state of the connection to the remote resource.

Optional privateLinkServiceId

privateLinkServiceId: undefined | string

The resource id of private link service.

Optional requestMessage

requestMessage: undefined | string

A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars.

serializedName

serializedName: string = "PrivateLinkServiceConnection"

type

type: object

className

className: string = "PrivateLinkServiceConnection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

groupIds

groupIds: object

serializedName

serializedName: string = "properties.groupIds"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

privateLinkServiceConnectionState

privateLinkServiceConnectionState: object

serializedName

serializedName: string = "properties.privateLinkServiceConnectionState"

type

type: object

className

className: string = "PrivateLinkServiceConnectionState"

name

name: "Composite" = "Composite"

privateLinkServiceId

privateLinkServiceId: object

serializedName

serializedName: string = "properties.privateLinkServiceId"

type

type: object

name

name: "String" = "String"

requestMessage

requestMessage: object

serializedName

serializedName: string = "properties.requestMessage"

type

type: object

name

name: "String" = "String"

Const PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionState: object

A collection of information about the state of the connection between service consumer and provider.

Optional actionRequired

actionRequired: undefined | string

A message indicating if changes on the service provider require any updates on the consumer.

Optional description

description: undefined | string

The reason for approval/rejection of the connection.

serializedName

serializedName: string = "PrivateLinkServiceConnectionState"

Optional status

status: undefined | string

Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

type

type: object

className

className: string = "PrivateLinkServiceConnectionState"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

actionRequired

actionRequired: object

serializedName

serializedName: string = "actionRequired"

type

type: object

name

name: "String" = "String"

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "String" = "String"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

Const PrivateLinkServiceIpConfiguration

PrivateLinkServiceIpConfiguration: object

The private link service ip configuration.

Optional name

name: undefined | string

The name of private link service ip configuration.

Optional privateIPAddress

privateIPAddress: undefined | string

The private IP address of the IP configuration.

Optional privateIPAddressVersion

privateIPAddressVersion: IPVersion

Available from Api-Version 2016-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values include: 'IPv4', 'IPv6'

Optional privateIPAllocationMethod

privateIPAllocationMethod: IPAllocationMethod

The private IP address allocation method. Possible values include: 'Static', 'Dynamic'

Optional provisioningState

provisioningState: undefined | string

Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

Optional publicIPAddress

publicIPAddress: PublicIPAddress

The reference of the public IP resource.

serializedName

serializedName: string = "PrivateLinkServiceIpConfiguration"

Optional subnet

subnet: Subnet

The reference of the subnet resource.

type

type: object

className

className: string = "PrivateLinkServiceIpConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

privateIPAddress

privateIPAddress: object

serializedName

serializedName: string = "properties.privateIPAddress"

type

type: object

name

name: "String" = "String"

privateIPAddressVersion

privateIPAddressVersion: object

serializedName

serializedName: string = "properties.privateIPAddressVersion"

type

type: object

name

name: "String" = "String"

privateIPAllocationMethod

privateIPAllocationMethod: object

serializedName

serializedName: string = "properties.privateIPAllocationMethod"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

publicIPAddress

publicIPAddress: object

serializedName

serializedName: string = "properties.publicIPAddress"

type

type: object

className

className: string = "PublicIPAddress"

name

name: "Composite" = "Composite"

subnet

subnet: object

serializedName

serializedName: string = "properties.subnet"

type

type: object

className

className: string = "Subnet"

name

name: "Composite" = "Composite"

Const PrivateLinkServiceListResult

PrivateLinkServiceListResult: object
interface

Response for the ListPrivateLinkService API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "PrivateLinkServiceListResult"

__@iterator

  • __@iterator(): IterableIterator<PrivateLinkService>
  • Iterator

    Returns IterableIterator<PrivateLinkService>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<PrivateLinkService>[]): PrivateLinkService[]
  • concat(...items: (T | ConcatArray<T>)[]): PrivateLinkService[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<PrivateLinkService>[]

      Additional items to add to the end of array1.

    Returns PrivateLinkService[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns PrivateLinkService[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, PrivateLinkService]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, PrivateLinkService]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: PrivateLinkService, index: number, array: PrivateLinkService[]): boolean
        • Parameters

          • value: PrivateLinkService
          • index: number
          • array: PrivateLinkService[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: PrivateLinkService, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: PrivateLinkService

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): PrivateLinkService[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: PrivateLinkService

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: PrivateLinkService, index: number, array: PrivateLinkService[]): boolean
        • Parameters

          • value: PrivateLinkService
          • index: number
          • array: PrivateLinkService[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: PrivateLinkService, index: number, array: PrivateLinkService[]): any
        • Parameters

          • value: PrivateLinkService
          • index: number
          • array: PrivateLinkService[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns PrivateLinkService[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): PrivateLinkService | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: PrivateLinkService

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: PrivateLinkService, index: number, obj: PrivateLinkService[]): boolean
        • Parameters

          • this: void
          • value: PrivateLinkService
          • index: number
          • obj: PrivateLinkService[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: PrivateLinkService, index: number, obj: PrivateLinkService[]): boolean
        • Parameters

          • value: PrivateLinkService
          • index: number
          • obj: PrivateLinkService[]

          Returns boolean

    • Optional thisArg: any

    Returns PrivateLinkService | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: PrivateLinkService, index: number, obj: PrivateLinkService[]): boolean
        • Parameters

          • value: PrivateLinkService
          • index: number
          • obj: PrivateLinkService[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: PrivateLinkService, index: number, array: PrivateLinkService[]): void
        • Parameters

          • value: PrivateLinkService
          • index: number
          • array: PrivateLinkService[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: PrivateLinkService, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: PrivateLinkService

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: PrivateLinkService, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: PrivateLinkService

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: PrivateLinkService, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: PrivateLinkService

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: PrivateLinkService, index: number, array: PrivateLinkService[]): U
        • Parameters

          • value: PrivateLinkService
          • index: number
          • array: PrivateLinkService[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): PrivateLinkService | undefined
  • Removes the last element from an array and returns it.

    Returns PrivateLinkService | undefined

push

  • push(...items: PrivateLinkService[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: PrivateLinkService[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): PrivateLinkService
  • reduce(callbackfn: function, initialValue: PrivateLinkService): PrivateLinkService
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: PrivateLinkService, currentValue: PrivateLinkService, currentIndex: number, array: PrivateLinkService[]): PrivateLinkService
        • Parameters

          • previousValue: PrivateLinkService
          • currentValue: PrivateLinkService
          • currentIndex: number
          • array: PrivateLinkService[]

          Returns PrivateLinkService

    Returns PrivateLinkService

  • Parameters

    • callbackfn: function
        • (previousValue: PrivateLinkService, currentValue: PrivateLinkService, currentIndex: number, array: PrivateLinkService[]): PrivateLinkService
        • Parameters

          • previousValue: PrivateLinkService
          • currentValue: PrivateLinkService
          • currentIndex: number
          • array: PrivateLinkService[]

          Returns PrivateLinkService

    • initialValue: PrivateLinkService

    Returns PrivateLinkService

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: PrivateLinkService, currentIndex: number, array: PrivateLinkService[]): U
        • Parameters

          • previousValue: U
          • currentValue: PrivateLinkService
          • currentIndex: number
          • array: PrivateLinkService[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): PrivateLinkService
  • reduceRight(callbackfn: function, initialValue: PrivateLinkService): PrivateLinkService
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: PrivateLinkService, currentValue: PrivateLinkService, currentIndex: number, array: PrivateLinkService[]): PrivateLinkService
        • Parameters

          • previousValue: PrivateLinkService
          • currentValue: PrivateLinkService
          • currentIndex: number
          • array: PrivateLinkService[]

          Returns PrivateLinkService

    Returns PrivateLinkService

  • Parameters

    • callbackfn: function
        • (previousValue: PrivateLinkService, currentValue: PrivateLinkService, currentIndex: number, array: PrivateLinkService[]): PrivateLinkService
        • Parameters

          • previousValue: PrivateLinkService
          • currentValue: PrivateLinkService
          • currentIndex: number
          • array: PrivateLinkService[]

          Returns PrivateLinkService

    • initialValue: PrivateLinkService

    Returns PrivateLinkService

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: PrivateLinkService, currentIndex: number, array: PrivateLinkService[]): U
        • Parameters

          • previousValue: U
          • currentValue: PrivateLinkService
          • currentIndex: number
          • array: PrivateLinkService[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): PrivateLinkService[]
  • Reverses the elements in an Array.

    Returns PrivateLinkService[]

shift

  • shift(): PrivateLinkService | undefined
  • Removes the first element from an array and returns it.

    Returns PrivateLinkService | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): PrivateLinkService[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns PrivateLinkService[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: PrivateLinkService, index: number, array: PrivateLinkService[]): boolean
        • Parameters

          • value: PrivateLinkService
          • index: number
          • array: PrivateLinkService[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): PrivateLinkService[]
  • splice(start: number, deleteCount: number, ...items: PrivateLinkService[]): PrivateLinkService[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns PrivateLinkService[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: PrivateLinkService[]

      Elements to insert into the array in place of the deleted elements.

    Returns PrivateLinkService[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: PrivateLinkService[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: PrivateLinkService[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<PrivateLinkService>
  • Returns an iterable of values in the array

    Returns IterableIterator<PrivateLinkService>

type

type: object

className

className: string = "PrivateLinkServiceListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PrivateLinkService"

name

name: "Composite" = "Composite"

Const PrivateLinkServicePropertiesAutoApproval

PrivateLinkServicePropertiesAutoApproval: object

The auto-approval list of the private link service.

serializedName

serializedName: string = "PrivateLinkServiceProperties_autoApproval"

Optional subscriptions

subscriptions: string[]

The list of subscriptions.

type

type: object

className

className: string = "PrivateLinkServicePropertiesAutoApproval"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

Const PrivateLinkServicePropertiesVisibility

PrivateLinkServicePropertiesVisibility: object

The visibility list of the private link service.

serializedName

serializedName: string = "PrivateLinkServiceProperties_visibility"

Optional subscriptions

subscriptions: string[]

The list of subscriptions.

type

type: object

className

className: string = "PrivateLinkServicePropertiesVisibility"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

Const Probe

Probe: object

A load balancer probe.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional intervalInSeconds

intervalInSeconds: undefined | number

The interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5.

Optional loadBalancingRules

loadBalancingRules: SubResource[]

The load balancer rules that use this probe. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Gets name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional numberOfProbes

numberOfProbes: undefined | number

The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure.

port

port: number

The port for communicating the probe. Possible values range from 1 to 65535, inclusive.

protocol

protocol: ProbeProtocol

The protocol of the end point. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' or 'Https' is specified, a 200 OK response from the specifies URI is required for the probe to be successful. Possible values include: 'Http', 'Tcp', 'Https'

Optional provisioningState

provisioningState: undefined | string

Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

Optional requestPath

requestPath: undefined | string

The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value.

serializedName

serializedName: string = "Probe"

type

type: object

className

className: string = "Probe"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

intervalInSeconds

intervalInSeconds: object

serializedName

serializedName: string = "properties.intervalInSeconds"

type

type: object

name

name: "Number" = "Number"

loadBalancingRules

loadBalancingRules: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.loadBalancingRules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

numberOfProbes

numberOfProbes: object

serializedName

serializedName: string = "properties.numberOfProbes"

type

type: object

name

name: "Number" = "Number"

port

port: object

required

required: true = true

serializedName

serializedName: string = "properties.port"

type

type: object

name

name: "Number" = "Number"

protocol

protocol: object

required

required: true = true

serializedName

serializedName: string = "properties.protocol"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

requestPath

requestPath: object

serializedName

serializedName: string = "properties.requestPath"

type

type: object

name

name: "String" = "String"

Const ProtocolConfiguration

ProtocolConfiguration: object

Configuration of the protocol.

Optional hTTPConfiguration

hTTPConfiguration: HTTPConfiguration

HTTP configuration of the connectivity check.

serializedName

serializedName: string = "ProtocolConfiguration"

type

type: object

className

className: string = "ProtocolConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

hTTPConfiguration

hTTPConfiguration: object

serializedName

serializedName: string = "HTTPConfiguration"

type

type: object

className

className: string = "HTTPConfiguration"

name

name: "Composite" = "Composite"

Const ProtocolCustomSettingsFormat

ProtocolCustomSettingsFormat: object

DDoS custom policy properties.

Optional protocol

The protocol for which the DDoS protection policy is being customized. Possible values include: 'Tcp', 'Udp', 'Syn'

serializedName

serializedName: string = "ProtocolCustomSettingsFormat"

Optional sourceRateOverride

sourceRateOverride: undefined | string

The customized DDoS protection source rate.

Optional triggerRateOverride

triggerRateOverride: undefined | string

The customized DDoS protection trigger rate.

Optional triggerSensitivityOverride

triggerSensitivityOverride: DdosCustomPolicyTriggerSensitivityOverride

The customized DDoS protection trigger rate sensitivity degrees. High: Trigger rate set with most sensitivity w.r.t. normal traffic. Default: Trigger rate set with moderate sensitivity w.r.t. normal traffic. Low: Trigger rate set with less sensitivity w.r.t. normal traffic. Relaxed: Trigger rate set with least sensitivity w.r.t. normal traffic. Possible values include: 'Relaxed', 'Low', 'Default', 'High'

type

type: object

className

className: string = "ProtocolCustomSettingsFormat"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

protocol

protocol: object

serializedName

serializedName: string = "protocol"

type

type: object

name

name: "String" = "String"

sourceRateOverride

sourceRateOverride: object

serializedName

serializedName: string = "sourceRateOverride"

type

type: object

name

name: "String" = "String"

triggerRateOverride

triggerRateOverride: object

serializedName

serializedName: string = "triggerRateOverride"

type

type: object

name

name: "String" = "String"

triggerSensitivityOverride

triggerSensitivityOverride: object

serializedName

serializedName: string = "triggerSensitivityOverride"

type

type: object

name

name: "String" = "String"

Const PublicIPAddress

PublicIPAddress: object

Public IP address resource.

Optional ddosSettings

ddosSettings: DdosSettings

The DDoS protection custom policy associated with the public IP address.

Optional dnsSettings

The FQDN of the DNS record associated with the public IP address.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional idleTimeoutInMinutes

idleTimeoutInMinutes: undefined | number

The idle timeout of the public IP address.

Optional ipAddress

ipAddress: undefined | string

The IP address associated with the public IP address resource.

Optional ipConfiguration

ipConfiguration: IPConfiguration

The IP configuration associated with the public IP address. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ipTags

ipTags: IpTag[]

The list of tags associated with the public IP address.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

Optional publicIPAddressVersion

publicIPAddressVersion: IPVersion

The public IP address version. Possible values include: 'IPv4', 'IPv6'

Optional publicIPAllocationMethod

publicIPAllocationMethod: IPAllocationMethod

The public IP address allocation method. Possible values include: 'Static', 'Dynamic'

Optional publicIPPrefix

publicIPPrefix: SubResource

The Public IP Prefix this Public IP Address should be allocated from.

Optional resourceGuid

resourceGuid: undefined | string

The resource GUID property of the public IP resource.

serializedName

serializedName: string = "PublicIPAddress"

Optional sku

The public IP address SKU.

Optional tags

tags: undefined | object

Resource tags.

Optional zones

zones: string[]

A list of availability zones denoting the IP allocated for the resource needs to come from.

type

type: object

className

className: string = "PublicIPAddress"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

ddosSettings

ddosSettings: object

serializedName

serializedName: string = "properties.ddosSettings"

type

type: object

className

className: string = "DdosSettings"

name

name: "Composite" = "Composite"

dnsSettings

dnsSettings: object

serializedName

serializedName: string = "properties.dnsSettings"

type

type: object

className

className: string = "PublicIPAddressDnsSettings"

name

name: "Composite" = "Composite"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

idleTimeoutInMinutes

idleTimeoutInMinutes: object

serializedName

serializedName: string = "properties.idleTimeoutInMinutes"

type

type: object

name

name: "Number" = "Number"

ipAddress

ipAddress: object

serializedName

serializedName: string = "properties.ipAddress"

type

type: object

name

name: "String" = "String"

ipConfiguration

ipConfiguration: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.ipConfiguration"

type

type: object

className

className: string = "IPConfiguration"

name

name: "Composite" = "Composite"

ipTags

ipTags: object

serializedName

serializedName: string = "properties.ipTags"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "IpTag"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

publicIPAddressVersion

publicIPAddressVersion: object

serializedName

serializedName: string = "properties.publicIPAddressVersion"

type

type: object

name

name: "String" = "String"

publicIPAllocationMethod

publicIPAllocationMethod: object

serializedName

serializedName: string = "properties.publicIPAllocationMethod"

type

type: object

name

name: "String" = "String"

publicIPPrefix

publicIPPrefix: object

serializedName

serializedName: string = "properties.publicIPPrefix"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

resourceGuid

resourceGuid: object

serializedName

serializedName: string = "properties.resourceGuid"

type

type: object

name

name: "String" = "String"

sku

sku: object

serializedName

serializedName: string = "sku"

type

type: object

className

className: string = "PublicIPAddressSku"

name

name: "Composite" = "Composite"

zones

zones: object

serializedName

serializedName: string = "zones"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const PublicIPAddressDnsSettings

PublicIPAddressDnsSettings: object

Contains FQDN of the DNS record associated with the public IP address.

Optional domainNameLabel

domainNameLabel: undefined | string

Gets or sets the Domain name label.The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.

Optional fqdn

fqdn: undefined | string

Gets the FQDN, Fully qualified domain name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone.

Optional reverseFqdn

reverseFqdn: undefined | string

Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN.

serializedName

serializedName: string = "PublicIPAddressDnsSettings"

type

type: object

className

className: string = "PublicIPAddressDnsSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

domainNameLabel

domainNameLabel: object

serializedName

serializedName: string = "domainNameLabel"

type

type: object

name

name: "String" = "String"

fqdn

fqdn: object

serializedName

serializedName: string = "fqdn"

type

type: object

name

name: "String" = "String"

reverseFqdn

reverseFqdn: object

serializedName

serializedName: string = "reverseFqdn"

type

type: object

name

name: "String" = "String"

Const PublicIPAddressListResult

PublicIPAddressListResult: object
interface

Response for ListPublicIpAddresses API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "PublicIPAddressListResult"

__@iterator

  • __@iterator(): IterableIterator<PublicIPAddress>
  • Iterator

    Returns IterableIterator<PublicIPAddress>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<PublicIPAddress>[]): PublicIPAddress[]
  • concat(...items: (T | ConcatArray<T>)[]): PublicIPAddress[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<PublicIPAddress>[]

      Additional items to add to the end of array1.

    Returns PublicIPAddress[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns PublicIPAddress[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, PublicIPAddress]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, PublicIPAddress]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: PublicIPAddress, index: number, array: PublicIPAddress[]): boolean
        • Parameters

          • value: PublicIPAddress
          • index: number
          • array: PublicIPAddress[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: PublicIPAddress, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: PublicIPAddress

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): PublicIPAddress[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: PublicIPAddress

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: PublicIPAddress, index: number, array: PublicIPAddress[]): boolean
        • Parameters

          • value: PublicIPAddress
          • index: number
          • array: PublicIPAddress[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: PublicIPAddress, index: number, array: PublicIPAddress[]): any
        • Parameters

          • value: PublicIPAddress
          • index: number
          • array: PublicIPAddress[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns PublicIPAddress[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): PublicIPAddress | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: PublicIPAddress

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: PublicIPAddress, index: number, obj: PublicIPAddress[]): boolean
        • Parameters

          • this: void
          • value: PublicIPAddress
          • index: number
          • obj: PublicIPAddress[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: PublicIPAddress, index: number, obj: PublicIPAddress[]): boolean
        • Parameters

          • value: PublicIPAddress
          • index: number
          • obj: PublicIPAddress[]

          Returns boolean

    • Optional thisArg: any

    Returns PublicIPAddress | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: PublicIPAddress, index: number, obj: PublicIPAddress[]): boolean
        • Parameters

          • value: PublicIPAddress
          • index: number
          • obj: PublicIPAddress[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: PublicIPAddress, index: number, array: PublicIPAddress[]): void
        • Parameters

          • value: PublicIPAddress
          • index: number
          • array: PublicIPAddress[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: PublicIPAddress, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: PublicIPAddress

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: PublicIPAddress, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: PublicIPAddress

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: PublicIPAddress, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: PublicIPAddress

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: PublicIPAddress, index: number, array: PublicIPAddress[]): U
        • Parameters

          • value: PublicIPAddress
          • index: number
          • array: PublicIPAddress[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): PublicIPAddress | undefined
  • Removes the last element from an array and returns it.

    Returns PublicIPAddress | undefined

push

  • push(...items: PublicIPAddress[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: PublicIPAddress[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): PublicIPAddress
  • reduce(callbackfn: function, initialValue: PublicIPAddress): PublicIPAddress
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: PublicIPAddress, currentValue: PublicIPAddress, currentIndex: number, array: PublicIPAddress[]): PublicIPAddress
        • Parameters

          • previousValue: PublicIPAddress
          • currentValue: PublicIPAddress
          • currentIndex: number
          • array: PublicIPAddress[]

          Returns PublicIPAddress

    Returns PublicIPAddress

  • Parameters

    • callbackfn: function
        • (previousValue: PublicIPAddress, currentValue: PublicIPAddress, currentIndex: number, array: PublicIPAddress[]): PublicIPAddress
        • Parameters

          • previousValue: PublicIPAddress
          • currentValue: PublicIPAddress
          • currentIndex: number
          • array: PublicIPAddress[]

          Returns PublicIPAddress

    • initialValue: PublicIPAddress

    Returns PublicIPAddress

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: PublicIPAddress, currentIndex: number, array: PublicIPAddress[]): U
        • Parameters

          • previousValue: U
          • currentValue: PublicIPAddress
          • currentIndex: number
          • array: PublicIPAddress[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): PublicIPAddress
  • reduceRight(callbackfn: function, initialValue: PublicIPAddress): PublicIPAddress
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: PublicIPAddress, currentValue: PublicIPAddress, currentIndex: number, array: PublicIPAddress[]): PublicIPAddress
        • Parameters

          • previousValue: PublicIPAddress
          • currentValue: PublicIPAddress
          • currentIndex: number
          • array: PublicIPAddress[]

          Returns PublicIPAddress

    Returns PublicIPAddress

  • Parameters

    • callbackfn: function
        • (previousValue: PublicIPAddress, currentValue: PublicIPAddress, currentIndex: number, array: PublicIPAddress[]): PublicIPAddress
        • Parameters

          • previousValue: PublicIPAddress
          • currentValue: PublicIPAddress
          • currentIndex: number
          • array: PublicIPAddress[]

          Returns PublicIPAddress

    • initialValue: PublicIPAddress

    Returns PublicIPAddress

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: PublicIPAddress, currentIndex: number, array: PublicIPAddress[]): U
        • Parameters

          • previousValue: U
          • currentValue: PublicIPAddress
          • currentIndex: number
          • array: PublicIPAddress[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): PublicIPAddress[]
  • Reverses the elements in an Array.

    Returns PublicIPAddress[]

shift

  • shift(): PublicIPAddress | undefined
  • Removes the first element from an array and returns it.

    Returns PublicIPAddress | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): PublicIPAddress[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns PublicIPAddress[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: PublicIPAddress, index: number, array: PublicIPAddress[]): boolean
        • Parameters

          • value: PublicIPAddress
          • index: number
          • array: PublicIPAddress[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): PublicIPAddress[]
  • splice(start: number, deleteCount: number, ...items: PublicIPAddress[]): PublicIPAddress[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns PublicIPAddress[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: PublicIPAddress[]

      Elements to insert into the array in place of the deleted elements.

    Returns PublicIPAddress[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: PublicIPAddress[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: PublicIPAddress[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<PublicIPAddress>
  • Returns an iterable of values in the array

    Returns IterableIterator<PublicIPAddress>

type

type: object

className

className: string = "PublicIPAddressListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PublicIPAddress"

name

name: "Composite" = "Composite"

Const PublicIPAddressSku

PublicIPAddressSku: object

SKU of a public IP address.

Optional name

Name of a public IP address SKU. Possible values include: 'Basic', 'Standard'

serializedName

serializedName: string = "PublicIPAddressSku"

type

type: object

className

className: string = "PublicIPAddressSku"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const PublicIPPrefix

PublicIPPrefix: object

Public IP prefix resource.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional ipPrefix

ipPrefix: undefined | string

The allocated Prefix.

Optional ipTags

ipTags: IpTag[]

The list of tags associated with the public IP prefix.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional prefixLength

prefixLength: undefined | number

The Length of the Public IP Prefix.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the Public IP prefix resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

Optional publicIPAddressVersion

publicIPAddressVersion: IPVersion

The public IP address version. Possible values include: 'IPv4', 'IPv6'

Optional publicIPAddresses

publicIPAddresses: ReferencedPublicIpAddress[]

The list of all referenced PublicIPAddresses.

Optional resourceGuid

resourceGuid: undefined | string

The resource GUID property of the public IP prefix resource.

serializedName

serializedName: string = "PublicIPPrefix"

Optional sku

The public IP prefix SKU.

Optional tags

tags: undefined | object

Resource tags.

Optional zones

zones: string[]

A list of availability zones denoting the IP allocated for the resource needs to come from.

type

type: object

className

className: string = "PublicIPPrefix"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

ipPrefix

ipPrefix: object

serializedName

serializedName: string = "properties.ipPrefix"

type

type: object

name

name: "String" = "String"

ipTags

ipTags: object

serializedName

serializedName: string = "properties.ipTags"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "IpTag"

name

name: "Composite" = "Composite"

prefixLength

prefixLength: object

serializedName

serializedName: string = "properties.prefixLength"

type

type: object

name

name: "Number" = "Number"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

publicIPAddressVersion

publicIPAddressVersion: object

serializedName

serializedName: string = "properties.publicIPAddressVersion"

type

type: object

name

name: "String" = "String"

publicIPAddresses

publicIPAddresses: object

serializedName

serializedName: string = "properties.publicIPAddresses"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ReferencedPublicIpAddress"

name

name: "Composite" = "Composite"

resourceGuid

resourceGuid: object

serializedName

serializedName: string = "properties.resourceGuid"

type

type: object

name

name: "String" = "String"

sku

sku: object

serializedName

serializedName: string = "sku"

type

type: object

className

className: string = "PublicIPPrefixSku"

name

name: "Composite" = "Composite"

zones

zones: object

serializedName

serializedName: string = "zones"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const PublicIPPrefixListResult

PublicIPPrefixListResult: object
interface

Response for ListPublicIpPrefixes API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "PublicIPPrefixListResult"

__@iterator

  • __@iterator(): IterableIterator<PublicIPPrefix>
  • Iterator

    Returns IterableIterator<PublicIPPrefix>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<PublicIPPrefix>[]): PublicIPPrefix[]
  • concat(...items: (T | ConcatArray<T>)[]): PublicIPPrefix[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<PublicIPPrefix>[]

      Additional items to add to the end of array1.

    Returns PublicIPPrefix[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns PublicIPPrefix[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, PublicIPPrefix]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, PublicIPPrefix]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: PublicIPPrefix, index: number, array: PublicIPPrefix[]): boolean
        • Parameters

          • value: PublicIPPrefix
          • index: number
          • array: PublicIPPrefix[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: PublicIPPrefix, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: PublicIPPrefix

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): PublicIPPrefix[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: PublicIPPrefix

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: PublicIPPrefix, index: number, array: PublicIPPrefix[]): boolean
        • Parameters

          • value: PublicIPPrefix
          • index: number
          • array: PublicIPPrefix[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: PublicIPPrefix, index: number, array: PublicIPPrefix[]): any
        • Parameters

          • value: PublicIPPrefix
          • index: number
          • array: PublicIPPrefix[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns PublicIPPrefix[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): PublicIPPrefix | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: PublicIPPrefix

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: PublicIPPrefix, index: number, obj: PublicIPPrefix[]): boolean
        • Parameters

          • this: void
          • value: PublicIPPrefix
          • index: number
          • obj: PublicIPPrefix[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: PublicIPPrefix, index: number, obj: PublicIPPrefix[]): boolean
        • Parameters

          • value: PublicIPPrefix
          • index: number
          • obj: PublicIPPrefix[]

          Returns boolean

    • Optional thisArg: any

    Returns PublicIPPrefix | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: PublicIPPrefix, index: number, obj: PublicIPPrefix[]): boolean
        • Parameters

          • value: PublicIPPrefix
          • index: number
          • obj: PublicIPPrefix[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: PublicIPPrefix, index: number, array: PublicIPPrefix[]): void
        • Parameters

          • value: PublicIPPrefix
          • index: number
          • array: PublicIPPrefix[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: PublicIPPrefix, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: PublicIPPrefix

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: PublicIPPrefix, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: PublicIPPrefix

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: PublicIPPrefix, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: PublicIPPrefix

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: PublicIPPrefix, index: number, array: PublicIPPrefix[]): U
        • Parameters

          • value: PublicIPPrefix
          • index: number
          • array: PublicIPPrefix[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): PublicIPPrefix | undefined
  • Removes the last element from an array and returns it.

    Returns PublicIPPrefix | undefined

push

  • push(...items: PublicIPPrefix[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: PublicIPPrefix[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): PublicIPPrefix
  • reduce(callbackfn: function, initialValue: PublicIPPrefix): PublicIPPrefix
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: PublicIPPrefix, currentValue: PublicIPPrefix, currentIndex: number, array: PublicIPPrefix[]): PublicIPPrefix
        • Parameters

          • previousValue: PublicIPPrefix
          • currentValue: PublicIPPrefix
          • currentIndex: number
          • array: PublicIPPrefix[]

          Returns PublicIPPrefix

    Returns PublicIPPrefix

  • Parameters

    • callbackfn: function
        • (previousValue: PublicIPPrefix, currentValue: PublicIPPrefix, currentIndex: number, array: PublicIPPrefix[]): PublicIPPrefix
        • Parameters

          • previousValue: PublicIPPrefix
          • currentValue: PublicIPPrefix
          • currentIndex: number
          • array: PublicIPPrefix[]

          Returns PublicIPPrefix

    • initialValue: PublicIPPrefix

    Returns PublicIPPrefix

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: PublicIPPrefix, currentIndex: number, array: PublicIPPrefix[]): U
        • Parameters

          • previousValue: U
          • currentValue: PublicIPPrefix
          • currentIndex: number
          • array: PublicIPPrefix[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): PublicIPPrefix
  • reduceRight(callbackfn: function, initialValue: PublicIPPrefix): PublicIPPrefix
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: PublicIPPrefix, currentValue: PublicIPPrefix, currentIndex: number, array: PublicIPPrefix[]): PublicIPPrefix
        • Parameters

          • previousValue: PublicIPPrefix
          • currentValue: PublicIPPrefix
          • currentIndex: number
          • array: PublicIPPrefix[]

          Returns PublicIPPrefix

    Returns PublicIPPrefix

  • Parameters

    • callbackfn: function
        • (previousValue: PublicIPPrefix, currentValue: PublicIPPrefix, currentIndex: number, array: PublicIPPrefix[]): PublicIPPrefix
        • Parameters

          • previousValue: PublicIPPrefix
          • currentValue: PublicIPPrefix
          • currentIndex: number
          • array: PublicIPPrefix[]

          Returns PublicIPPrefix

    • initialValue: PublicIPPrefix

    Returns PublicIPPrefix

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: PublicIPPrefix, currentIndex: number, array: PublicIPPrefix[]): U
        • Parameters

          • previousValue: U
          • currentValue: PublicIPPrefix
          • currentIndex: number
          • array: PublicIPPrefix[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): PublicIPPrefix[]
  • Reverses the elements in an Array.

    Returns PublicIPPrefix[]

shift

  • shift(): PublicIPPrefix | undefined
  • Removes the first element from an array and returns it.

    Returns PublicIPPrefix | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): PublicIPPrefix[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns PublicIPPrefix[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: PublicIPPrefix, index: number, array: PublicIPPrefix[]): boolean
        • Parameters

          • value: PublicIPPrefix
          • index: number
          • array: PublicIPPrefix[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): PublicIPPrefix[]
  • splice(start: number, deleteCount: number, ...items: PublicIPPrefix[]): PublicIPPrefix[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns PublicIPPrefix[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: PublicIPPrefix[]

      Elements to insert into the array in place of the deleted elements.

    Returns PublicIPPrefix[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: PublicIPPrefix[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: PublicIPPrefix[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<PublicIPPrefix>
  • Returns an iterable of values in the array

    Returns IterableIterator<PublicIPPrefix>

type

type: object

className

className: string = "PublicIPPrefixListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PublicIPPrefix"

name

name: "Composite" = "Composite"

Const PublicIPPrefixSku

PublicIPPrefixSku: object

SKU of a public IP prefix.

Optional name

Name of a public IP prefix SKU. Possible values include: 'Standard'

serializedName

serializedName: string = "PublicIPPrefixSku"

type

type: object

className

className: string = "PublicIPPrefixSku"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const QueryTroubleshootingParameters

QueryTroubleshootingParameters: object

Parameters that define the resource to query the troubleshooting result.

serializedName

serializedName: string = "QueryTroubleshootingParameters"

targetResourceId

targetResourceId: string

The target resource ID to query the troubleshooting result.

type

type: object

className

className: string = "QueryTroubleshootingParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

targetResourceId

targetResourceId: object

required

required: true = true

serializedName

serializedName: string = "targetResourceId"

type

type: object

name

name: "String" = "String"

Const ReferencedPublicIpAddress

ReferencedPublicIpAddress: object

Reference to a public IP address.

Optional id

id: undefined | string

The PublicIPAddress Reference.

serializedName

serializedName: string = "ReferencedPublicIpAddress"

type

type: object

className

className: string = "ReferencedPublicIpAddress"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

Const Resource

Resource: object

Common resource representation.

Optional id

id: undefined | string

Resource ID.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Resource"

Optional tags

tags: undefined | object

Resource tags.

type

type: object

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Resource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const ResourceNavigationLink

ResourceNavigationLink: object

ResourceNavigationLink resource.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID.

Optional link

link: undefined | string

Link to the external resource.

Optional linkedResourceType

linkedResourceType: undefined | string

Resource type of the linked resource.

Optional name

name: undefined | string

Name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional provisioningState

provisioningState: undefined | string

Provisioning state of the ResourceNavigationLink resource. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ResourceNavigationLink"

type

type: object

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "ResourceNavigationLink"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

etag

etag: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

link

link: object

serializedName

serializedName: string = "properties.link"

type

type: object

name

name: "String" = "String"

linkedResourceType

linkedResourceType: object

serializedName

serializedName: string = "properties.linkedResourceType"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const ResourceNavigationLinksListResult

ResourceNavigationLinksListResult: object

Response for ResourceNavigationLinks_List operation.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ResourceNavigationLinksListResult"

Optional value

value: ResourceNavigationLink[]

The resource navigation links in a subnet.

type

type: object

className

className: string = "ResourceNavigationLinksListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ResourceNavigationLink"

name

name: "Composite" = "Composite"

Const ResourceSet

ResourceSet: object

The base resource set for visibility and auto-approval.

serializedName

serializedName: string = "ResourceSet"

Optional subscriptions

subscriptions: string[]

The list of subscriptions.

type

type: object

className

className: string = "ResourceSet"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

subscriptions

subscriptions: object

serializedName

serializedName: string = "subscriptions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const RetentionPolicyParameters

RetentionPolicyParameters: object

Parameters that define the retention policy for flow log.

Optional days

days: undefined | number

Number of days to retain flow log records. Default value: 0.

Optional enabled

enabled: undefined | false | true

Flag to enable/disable retention. Default value: false.

serializedName

serializedName: string = "RetentionPolicyParameters"

type

type: object

className

className: string = "RetentionPolicyParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

days

days: object

defaultValue

defaultValue: number = 0

serializedName

serializedName: string = "days"

type

type: object

name

name: "Number" = "Number"

enabled

enabled: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "enabled"

type

type: object

name

name: "Boolean" = "Boolean"

Const Route

Route: object

Route resource.

Optional addressPrefix

addressPrefix: undefined | string

The destination CIDR to which the route applies.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional nextHopIpAddress

nextHopIpAddress: undefined | string

The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.

nextHopType

nextHopType: RouteNextHopType

The type of Azure hop the packet should be sent to. Possible values include: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', 'None'

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

serializedName

serializedName: string = "Route"

type

type: object

className

className: string = "Route"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

addressPrefix

addressPrefix: object

serializedName

serializedName: string = "properties.addressPrefix"

type

type: object

name

name: "String" = "String"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

nextHopIpAddress

nextHopIpAddress: object

serializedName

serializedName: string = "properties.nextHopIpAddress"

type

type: object

name

name: "String" = "String"

nextHopType

nextHopType: object

required

required: true = true

serializedName

serializedName: string = "properties.nextHopType"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

Const RouteFilter

RouteFilter: object

Route Filter Resource.

Optional etag

etag: undefined | string

Gets a unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID.

Optional ipv6Peerings

ipv6Peerings: ExpressRouteCircuitPeering[]

A collection of references to express route circuit ipv6 peerings.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional peerings

peerings: ExpressRouteCircuitPeering[]

A collection of references to express route circuit peerings.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. NOTE: This property will not be serialized. It can only be populated by the server.

Optional rules

rules: RouteFilterRule[]

Collection of RouteFilterRules contained within a route filter.

serializedName

serializedName: string = "RouteFilter"

Optional tags

tags: undefined | object

Resource tags.

type

type: object

className

className: string = "RouteFilter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

etag

etag: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

ipv6Peerings

ipv6Peerings: object

serializedName

serializedName: string = "properties.ipv6Peerings"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ExpressRouteCircuitPeering"

name

name: "Composite" = "Composite"

peerings

peerings: object

serializedName

serializedName: string = "properties.peerings"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ExpressRouteCircuitPeering"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

rules

rules: object

serializedName

serializedName: string = "properties.rules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RouteFilterRule"

name

name: "Composite" = "Composite"

Const RouteFilterListResult

RouteFilterListResult: object
interface

Response for the ListRouteFilters API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "RouteFilterListResult"

__@iterator

  • __@iterator(): IterableIterator<RouteFilter>
  • Iterator

    Returns IterableIterator<RouteFilter>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<RouteFilter>[]): RouteFilter[]
  • concat(...items: (T | ConcatArray<T>)[]): RouteFilter[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<RouteFilter>[]

      Additional items to add to the end of array1.

    Returns RouteFilter[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns RouteFilter[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, RouteFilter]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, RouteFilter]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: RouteFilter, index: number, array: RouteFilter[]): boolean
        • Parameters

          • value: RouteFilter
          • index: number
          • array: RouteFilter[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: RouteFilter, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: RouteFilter

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): RouteFilter[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: RouteFilter

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: RouteFilter, index: number, array: RouteFilter[]): boolean
        • Parameters

          • value: RouteFilter
          • index: number
          • array: RouteFilter[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: RouteFilter, index: number, array: RouteFilter[]): any
        • Parameters

          • value: RouteFilter
          • index: number
          • array: RouteFilter[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns RouteFilter[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): RouteFilter | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: RouteFilter

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: RouteFilter, index: number, obj: RouteFilter[]): boolean
        • Parameters

          • this: void
          • value: RouteFilter
          • index: number
          • obj: RouteFilter[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: RouteFilter, index: number, obj: RouteFilter[]): boolean
        • Parameters

          • value: RouteFilter
          • index: number
          • obj: RouteFilter[]

          Returns boolean

    • Optional thisArg: any

    Returns RouteFilter | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: RouteFilter, index: number, obj: RouteFilter[]): boolean
        • Parameters

          • value: RouteFilter
          • index: number
          • obj: RouteFilter[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: RouteFilter, index: number, array: RouteFilter[]): void
        • Parameters

          • value: RouteFilter
          • index: number
          • array: RouteFilter[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: RouteFilter, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: RouteFilter

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: RouteFilter, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: RouteFilter

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: RouteFilter, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: RouteFilter

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: RouteFilter, index: number, array: RouteFilter[]): U
        • Parameters

          • value: RouteFilter
          • index: number
          • array: RouteFilter[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): RouteFilter | undefined
  • Removes the last element from an array and returns it.

    Returns RouteFilter | undefined

push

  • push(...items: RouteFilter[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: RouteFilter[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): RouteFilter
  • reduce(callbackfn: function, initialValue: RouteFilter): RouteFilter
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: RouteFilter, currentValue: RouteFilter, currentIndex: number, array: RouteFilter[]): RouteFilter
        • Parameters

          • previousValue: RouteFilter
          • currentValue: RouteFilter
          • currentIndex: number
          • array: RouteFilter[]

          Returns RouteFilter

    Returns RouteFilter

  • Parameters

    • callbackfn: function
        • (previousValue: RouteFilter, currentValue: RouteFilter, currentIndex: number, array: RouteFilter[]): RouteFilter
        • Parameters

          • previousValue: RouteFilter
          • currentValue: RouteFilter
          • currentIndex: number
          • array: RouteFilter[]

          Returns RouteFilter

    • initialValue: RouteFilter

    Returns RouteFilter

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: RouteFilter, currentIndex: number, array: RouteFilter[]): U
        • Parameters

          • previousValue: U
          • currentValue: RouteFilter
          • currentIndex: number
          • array: RouteFilter[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): RouteFilter
  • reduceRight(callbackfn: function, initialValue: RouteFilter): RouteFilter
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: RouteFilter, currentValue: RouteFilter, currentIndex: number, array: RouteFilter[]): RouteFilter
        • Parameters

          • previousValue: RouteFilter
          • currentValue: RouteFilter
          • currentIndex: number
          • array: RouteFilter[]

          Returns RouteFilter

    Returns RouteFilter

  • Parameters

    • callbackfn: function
        • (previousValue: RouteFilter, currentValue: RouteFilter, currentIndex: number, array: RouteFilter[]): RouteFilter
        • Parameters

          • previousValue: RouteFilter
          • currentValue: RouteFilter
          • currentIndex: number
          • array: RouteFilter[]

          Returns RouteFilter

    • initialValue: RouteFilter

    Returns RouteFilter

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: RouteFilter, currentIndex: number, array: RouteFilter[]): U
        • Parameters

          • previousValue: U
          • currentValue: RouteFilter
          • currentIndex: number
          • array: RouteFilter[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): RouteFilter[]
  • Reverses the elements in an Array.

    Returns RouteFilter[]

shift

  • shift(): RouteFilter | undefined
  • Removes the first element from an array and returns it.

    Returns RouteFilter | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): RouteFilter[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns RouteFilter[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: RouteFilter, index: number, array: RouteFilter[]): boolean
        • Parameters

          • value: RouteFilter
          • index: number
          • array: RouteFilter[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): RouteFilter[]
  • splice(start: number, deleteCount: number, ...items: RouteFilter[]): RouteFilter[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns RouteFilter[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: RouteFilter[]

      Elements to insert into the array in place of the deleted elements.

    Returns RouteFilter[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: RouteFilter[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: RouteFilter[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<RouteFilter>
  • Returns an iterable of values in the array

    Returns IterableIterator<RouteFilter>

type

type: object

className

className: string = "RouteFilterListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RouteFilter"

name

name: "Composite" = "Composite"

Const RouteFilterRule

RouteFilterRule: object

Route Filter Rule Resource.

access

access: Access

The access type of the rule. Possible values include: 'Allow', 'Deny'

communities

communities: string[]

The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'].

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "RouteFilterRule"

type

type: object

className

className: string = "RouteFilterRule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

access

access: object

required

required: true = true

serializedName

serializedName: string = "properties.access"

type

type: object

name

name: "String" = "String"

communities

communities: object

required

required: true = true

serializedName

serializedName: string = "properties.communities"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

etag

etag: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

routeFilterRuleType

routeFilterRuleType: object

defaultValue

defaultValue: string = "Community"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "properties.routeFilterRuleType"

type

type: object

name

name: "String" = "String"

Const RouteFilterRuleListResult

RouteFilterRuleListResult: object
interface

Response for the ListRouteFilterRules API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "RouteFilterRuleListResult"

__@iterator

  • __@iterator(): IterableIterator<RouteFilterRule>
  • Iterator

    Returns IterableIterator<RouteFilterRule>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<RouteFilterRule>[]): RouteFilterRule[]
  • concat(...items: (T | ConcatArray<T>)[]): RouteFilterRule[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<RouteFilterRule>[]

      Additional items to add to the end of array1.

    Returns RouteFilterRule[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns RouteFilterRule[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, RouteFilterRule]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, RouteFilterRule]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: RouteFilterRule, index: number, array: RouteFilterRule[]): boolean
        • Parameters

          • value: RouteFilterRule
          • index: number
          • array: RouteFilterRule[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: RouteFilterRule, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: RouteFilterRule

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): RouteFilterRule[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: RouteFilterRule

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: RouteFilterRule, index: number, array: RouteFilterRule[]): boolean
        • Parameters

          • value: RouteFilterRule
          • index: number
          • array: RouteFilterRule[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: RouteFilterRule, index: number, array: RouteFilterRule[]): any
        • Parameters

          • value: RouteFilterRule
          • index: number
          • array: RouteFilterRule[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns RouteFilterRule[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): RouteFilterRule | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: RouteFilterRule

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: RouteFilterRule, index: number, obj: RouteFilterRule[]): boolean
        • Parameters

          • this: void
          • value: RouteFilterRule
          • index: number
          • obj: RouteFilterRule[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: RouteFilterRule, index: number, obj: RouteFilterRule[]): boolean
        • Parameters

          • value: RouteFilterRule
          • index: number
          • obj: RouteFilterRule[]

          Returns boolean

    • Optional thisArg: any

    Returns RouteFilterRule | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: RouteFilterRule, index: number, obj: RouteFilterRule[]): boolean
        • Parameters

          • value: RouteFilterRule
          • index: number
          • obj: RouteFilterRule[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: RouteFilterRule, index: number, array: RouteFilterRule[]): void
        • Parameters

          • value: RouteFilterRule
          • index: number
          • array: RouteFilterRule[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: RouteFilterRule, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: RouteFilterRule

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: RouteFilterRule, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: RouteFilterRule

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: RouteFilterRule, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: RouteFilterRule

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: RouteFilterRule, index: number, array: RouteFilterRule[]): U
        • Parameters

          • value: RouteFilterRule
          • index: number
          • array: RouteFilterRule[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): RouteFilterRule | undefined
  • Removes the last element from an array and returns it.

    Returns RouteFilterRule | undefined

push

  • push(...items: RouteFilterRule[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: RouteFilterRule[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): RouteFilterRule
  • reduce(callbackfn: function, initialValue: RouteFilterRule): RouteFilterRule
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: RouteFilterRule, currentValue: RouteFilterRule, currentIndex: number, array: RouteFilterRule[]): RouteFilterRule
        • Parameters

          • previousValue: RouteFilterRule
          • currentValue: RouteFilterRule
          • currentIndex: number
          • array: RouteFilterRule[]

          Returns RouteFilterRule

    Returns RouteFilterRule

  • Parameters

    • callbackfn: function
        • (previousValue: RouteFilterRule, currentValue: RouteFilterRule, currentIndex: number, array: RouteFilterRule[]): RouteFilterRule
        • Parameters

          • previousValue: RouteFilterRule
          • currentValue: RouteFilterRule
          • currentIndex: number
          • array: RouteFilterRule[]

          Returns RouteFilterRule

    • initialValue: RouteFilterRule

    Returns RouteFilterRule

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: RouteFilterRule, currentIndex: number, array: RouteFilterRule[]): U
        • Parameters

          • previousValue: U
          • currentValue: RouteFilterRule
          • currentIndex: number
          • array: RouteFilterRule[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): RouteFilterRule
  • reduceRight(callbackfn: function, initialValue: RouteFilterRule): RouteFilterRule
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: RouteFilterRule, currentValue: RouteFilterRule, currentIndex: number, array: RouteFilterRule[]): RouteFilterRule
        • Parameters

          • previousValue: RouteFilterRule
          • currentValue: RouteFilterRule
          • currentIndex: number
          • array: RouteFilterRule[]

          Returns RouteFilterRule

    Returns RouteFilterRule

  • Parameters

    • callbackfn: function
        • (previousValue: RouteFilterRule, currentValue: RouteFilterRule, currentIndex: number, array: RouteFilterRule[]): RouteFilterRule
        • Parameters

          • previousValue: RouteFilterRule
          • currentValue: RouteFilterRule
          • currentIndex: number
          • array: RouteFilterRule[]

          Returns RouteFilterRule

    • initialValue: RouteFilterRule

    Returns RouteFilterRule

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: RouteFilterRule, currentIndex: number, array: RouteFilterRule[]): U
        • Parameters

          • previousValue: U
          • currentValue: RouteFilterRule
          • currentIndex: number
          • array: RouteFilterRule[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): RouteFilterRule[]
  • Reverses the elements in an Array.

    Returns RouteFilterRule[]

shift

  • shift(): RouteFilterRule | undefined
  • Removes the first element from an array and returns it.

    Returns RouteFilterRule | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): RouteFilterRule[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns RouteFilterRule[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: RouteFilterRule, index: number, array: RouteFilterRule[]): boolean
        • Parameters

          • value: RouteFilterRule
          • index: number
          • array: RouteFilterRule[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): RouteFilterRule[]
  • splice(start: number, deleteCount: number, ...items: RouteFilterRule[]): RouteFilterRule[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns RouteFilterRule[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: RouteFilterRule[]

      Elements to insert into the array in place of the deleted elements.

    Returns RouteFilterRule[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: RouteFilterRule[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: RouteFilterRule[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<RouteFilterRule>
  • Returns an iterable of values in the array

    Returns IterableIterator<RouteFilterRule>

type

type: object

className

className: string = "RouteFilterRuleListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RouteFilterRule"

name

name: "Composite" = "Composite"

Const RouteListResult

RouteListResult: object
interface

Response for the ListRoute API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "RouteListResult"

__@iterator

  • __@iterator(): IterableIterator<Route>
  • Iterator

    Returns IterableIterator<Route>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Route>[]): Route[]
  • concat(...items: (T | ConcatArray<T>)[]): Route[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Route>[]

      Additional items to add to the end of array1.

    Returns Route[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Route[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Route]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Route]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: Route, index: number, array: Route[]): boolean
        • Parameters

          • value: Route
          • index: number
          • array: Route[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Route, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Route

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Route[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: Route

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Route, index: number, array: Route[]): boolean
        • Parameters

          • value: Route
          • index: number
          • array: Route[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Route, index: number, array: Route[]): any
        • Parameters

          • value: Route
          • index: number
          • array: Route[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Route[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Route | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: Route

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Route, index: number, obj: Route[]): boolean
        • Parameters

          • this: void
          • value: Route
          • index: number
          • obj: Route[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: Route, index: number, obj: Route[]): boolean
        • Parameters

          • value: Route
          • index: number
          • obj: Route[]

          Returns boolean

    • Optional thisArg: any

    Returns Route | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: Route, index: number, obj: Route[]): boolean
        • Parameters

          • value: Route
          • index: number
          • obj: Route[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: Route, index: number, array: Route[]): void
        • Parameters

          • value: Route
          • index: number
          • array: Route[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Route, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Route

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Route, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Route

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Route, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Route

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: Route, index: number, array: Route[]): U
        • Parameters

          • value: Route
          • index: number
          • array: Route[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): Route | undefined
  • Removes the last element from an array and returns it.

    Returns Route | undefined

push

  • push(...items: Route[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Route[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Route
  • reduce(callbackfn: function, initialValue: Route): Route
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: Route, currentValue: Route, currentIndex: number, array: Route[]): Route
        • Parameters

          • previousValue: Route
          • currentValue: Route
          • currentIndex: number
          • array: Route[]

          Returns Route

    Returns Route

  • Parameters

    • callbackfn: function
        • (previousValue: Route, currentValue: Route, currentIndex: number, array: Route[]): Route
        • Parameters

          • previousValue: Route
          • currentValue: Route
          • currentIndex: number
          • array: Route[]

          Returns Route

    • initialValue: Route

    Returns Route

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Route, currentIndex: number, array: Route[]): U
        • Parameters

          • previousValue: U
          • currentValue: Route
          • currentIndex: number
          • array: Route[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Route
  • reduceRight(callbackfn: function, initialValue: Route): Route
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: Route, currentValue: Route, currentIndex: number, array: Route[]): Route
        • Parameters

          • previousValue: Route
          • currentValue: Route
          • currentIndex: number
          • array: Route[]

          Returns Route

    Returns Route

  • Parameters

    • callbackfn: function
        • (previousValue: Route, currentValue: Route, currentIndex: number, array: Route[]): Route
        • Parameters

          • previousValue: Route
          • currentValue: Route
          • currentIndex: number
          • array: Route[]

          Returns Route

    • initialValue: Route

    Returns Route

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Route, currentIndex: number, array: Route[]): U
        • Parameters

          • previousValue: U
          • currentValue: Route
          • currentIndex: number
          • array: Route[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): Route[]
  • Reverses the elements in an Array.

    Returns Route[]

shift

  • shift(): Route | undefined
  • Removes the first element from an array and returns it.

    Returns Route | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Route[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Route[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: Route, index: number, array: Route[]): boolean
        • Parameters

          • value: Route
          • index: number
          • array: Route[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Route[]
  • splice(start: number, deleteCount: number, ...items: Route[]): Route[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Route[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Route[]

      Elements to insert into the array in place of the deleted elements.

    Returns Route[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Route[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Route[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Route>
  • Returns an iterable of values in the array

    Returns IterableIterator<Route>

type

type: object

className

className: string = "RouteListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Route"

name

name: "Composite" = "Composite"

Const RouteTable

RouteTable: object

Route table resource.

Optional disableBgpRoutePropagation

disableBgpRoutePropagation: undefined | false | true

Gets or sets whether to disable the routes learned by BGP on that route table. True means disable.

Optional etag

etag: undefined | string

Gets a unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

Optional routes

routes: Route[]

Collection of routes contained within a route table.

serializedName

serializedName: string = "RouteTable"

Optional subnets

subnets: Subnet[]

A collection of references to subnets. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object

Resource tags.

type

type: object

className

className: string = "RouteTable"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

disableBgpRoutePropagation

disableBgpRoutePropagation: object

serializedName

serializedName: string = "properties.disableBgpRoutePropagation"

type

type: object

name

name: "Boolean" = "Boolean"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

routes

routes: object

serializedName

serializedName: string = "properties.routes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Route"

name

name: "Composite" = "Composite"

subnets

subnets: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.subnets"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Subnet"

name

name: "Composite" = "Composite"

Const RouteTableListResult

RouteTableListResult: object
interface

Response for the ListRouteTable API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "RouteTableListResult"

__@iterator

  • __@iterator(): IterableIterator<RouteTable>
  • Iterator

    Returns IterableIterator<RouteTable>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<RouteTable>[]): RouteTable[]
  • concat(...items: (T | ConcatArray<T>)[]): RouteTable[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<RouteTable>[]

      Additional items to add to the end of array1.

    Returns RouteTable[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns RouteTable[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, RouteTable]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, RouteTable]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: RouteTable, index: number, array: RouteTable[]): boolean
        • Parameters

          • value: RouteTable
          • index: number
          • array: RouteTable[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: RouteTable, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: RouteTable

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): RouteTable[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: RouteTable

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: RouteTable, index: number, array: RouteTable[]): boolean
        • Parameters

          • value: RouteTable
          • index: number
          • array: RouteTable[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: RouteTable, index: number, array: RouteTable[]): any
        • Parameters

          • value: RouteTable
          • index: number
          • array: RouteTable[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns RouteTable[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): RouteTable | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: RouteTable

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: RouteTable, index: number, obj: RouteTable[]): boolean
        • Parameters

          • this: void
          • value: RouteTable
          • index: number
          • obj: RouteTable[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: RouteTable, index: number, obj: RouteTable[]): boolean
        • Parameters

          • value: RouteTable
          • index: number
          • obj: RouteTable[]

          Returns boolean

    • Optional thisArg: any

    Returns RouteTable | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: RouteTable, index: number, obj: RouteTable[]): boolean
        • Parameters

          • value: RouteTable
          • index: number
          • obj: RouteTable[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: RouteTable, index: number, array: RouteTable[]): void
        • Parameters

          • value: RouteTable
          • index: number
          • array: RouteTable[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: RouteTable, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: RouteTable

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: RouteTable, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: RouteTable

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: RouteTable, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: RouteTable

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: RouteTable, index: number, array: RouteTable[]): U
        • Parameters

          • value: RouteTable
          • index: number
          • array: RouteTable[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): RouteTable | undefined
  • Removes the last element from an array and returns it.

    Returns RouteTable | undefined

push

  • push(...items: RouteTable[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: RouteTable[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): RouteTable
  • reduce(callbackfn: function, initialValue: RouteTable): RouteTable
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: RouteTable, currentValue: RouteTable, currentIndex: number, array: RouteTable[]): RouteTable
        • Parameters

          • previousValue: RouteTable
          • currentValue: RouteTable
          • currentIndex: number
          • array: RouteTable[]

          Returns RouteTable

    Returns RouteTable

  • Parameters

    • callbackfn: function
        • (previousValue: RouteTable, currentValue: RouteTable, currentIndex: number, array: RouteTable[]): RouteTable
        • Parameters

          • previousValue: RouteTable
          • currentValue: RouteTable
          • currentIndex: number
          • array: RouteTable[]

          Returns RouteTable

    • initialValue: RouteTable

    Returns RouteTable

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: RouteTable, currentIndex: number, array: RouteTable[]): U
        • Parameters

          • previousValue: U
          • currentValue: RouteTable
          • currentIndex: number
          • array: RouteTable[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): RouteTable
  • reduceRight(callbackfn: function, initialValue: RouteTable): RouteTable
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: RouteTable, currentValue: RouteTable, currentIndex: number, array: RouteTable[]): RouteTable
        • Parameters

          • previousValue: RouteTable
          • currentValue: RouteTable
          • currentIndex: number
          • array: RouteTable[]

          Returns RouteTable

    Returns RouteTable

  • Parameters

    • callbackfn: function
        • (previousValue: RouteTable, currentValue: RouteTable, currentIndex: number, array: RouteTable[]): RouteTable
        • Parameters

          • previousValue: RouteTable
          • currentValue: RouteTable
          • currentIndex: number
          • array: RouteTable[]

          Returns RouteTable

    • initialValue: RouteTable

    Returns RouteTable

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: RouteTable, currentIndex: number, array: RouteTable[]): U
        • Parameters

          • previousValue: U
          • currentValue: RouteTable
          • currentIndex: number
          • array: RouteTable[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): RouteTable[]
  • Reverses the elements in an Array.

    Returns RouteTable[]

shift

  • shift(): RouteTable | undefined
  • Removes the first element from an array and returns it.

    Returns RouteTable | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): RouteTable[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns RouteTable[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: RouteTable, index: number, array: RouteTable[]): boolean
        • Parameters

          • value: RouteTable
          • index: number
          • array: RouteTable[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): RouteTable[]
  • splice(start: number, deleteCount: number, ...items: RouteTable[]): RouteTable[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns RouteTable[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: RouteTable[]

      Elements to insert into the array in place of the deleted elements.

    Returns RouteTable[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: RouteTable[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: RouteTable[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<RouteTable>
  • Returns an iterable of values in the array

    Returns IterableIterator<RouteTable>

type

type: object

className

className: string = "RouteTableListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RouteTable"

name

name: "Composite" = "Composite"

Const SecurityGroupNetworkInterface

SecurityGroupNetworkInterface: object

Network interface and all its associated security rules.

Optional id

id: undefined | string

ID of the network interface.

Optional securityRuleAssociations

securityRuleAssociations: SecurityRuleAssociations

All security rules associated with the network interface.

serializedName

serializedName: string = "SecurityGroupNetworkInterface"

type

type: object

className

className: string = "SecurityGroupNetworkInterface"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

securityRuleAssociations

securityRuleAssociations: object

serializedName

serializedName: string = "securityRuleAssociations"

type

type: object

className

className: string = "SecurityRuleAssociations"

name

name: "Composite" = "Composite"

Const SecurityGroupViewParameters

SecurityGroupViewParameters: object

Parameters that define the VM to check security groups for.

serializedName

serializedName: string = "SecurityGroupViewParameters"

targetResourceId

targetResourceId: string

ID of the target VM.

type

type: object

className

className: string = "SecurityGroupViewParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

targetResourceId

targetResourceId: object

required

required: true = true

serializedName

serializedName: string = "targetResourceId"

type

type: object

name

name: "String" = "String"

Const SecurityGroupViewResult

SecurityGroupViewResult: object

The information about security rules applied to the specified VM.

Optional networkInterfaces

networkInterfaces: SecurityGroupNetworkInterface[]

List of network interfaces on the specified VM.

serializedName

serializedName: string = "SecurityGroupViewResult"

type

type: object

className

className: string = "SecurityGroupViewResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

networkInterfaces

networkInterfaces: object

serializedName

serializedName: string = "networkInterfaces"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SecurityGroupNetworkInterface"

name

name: "Composite" = "Composite"

Const SecurityRule

SecurityRule: object

Network security rule.

access

The network traffic is allowed or denied. Possible values include: 'Allow', 'Deny'

Optional description

description: undefined | string

A description for this rule. Restricted to 140 chars.

Optional destinationAddressPrefix

destinationAddressPrefix: undefined | string

The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.

Optional destinationAddressPrefixes

destinationAddressPrefixes: string[]

The destination address prefixes. CIDR or destination IP ranges.

Optional destinationApplicationSecurityGroups

destinationApplicationSecurityGroups: ApplicationSecurityGroup[]

The application security group specified as destination.

Optional destinationPortRange

destinationPortRange: undefined | string

The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.

Optional destinationPortRanges

destinationPortRanges: string[]

The destination port ranges.

direction

The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. Possible values include: 'Inbound', 'Outbound'

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional priority

priority: undefined | number

The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.

protocol

Network protocol this rule applies to. Possible values include: 'Tcp', 'Udp', 'Icmp', 'Esp', '*'

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

serializedName

serializedName: string = "SecurityRule"

Optional sourceAddressPrefix

sourceAddressPrefix: undefined | string

The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from.

Optional sourceAddressPrefixes

sourceAddressPrefixes: string[]

The CIDR or source IP ranges.

Optional sourceApplicationSecurityGroups

sourceApplicationSecurityGroups: ApplicationSecurityGroup[]

The application security group specified as source.

Optional sourcePortRange

sourcePortRange: undefined | string

The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.

Optional sourcePortRanges

sourcePortRanges: string[]

The source port ranges.

type

type: object

className

className: string = "SecurityRule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

access

access: object

required

required: true = true

serializedName

serializedName: string = "properties.access"

type

type: object

name

name: "String" = "String"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

destinationAddressPrefix

destinationAddressPrefix: object

serializedName

serializedName: string = "properties.destinationAddressPrefix"

type

type: object

name

name: "String" = "String"

destinationAddressPrefixes

destinationAddressPrefixes: object

serializedName

serializedName: string = "properties.destinationAddressPrefixes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

destinationApplicationSecurityGroups

destinationApplicationSecurityGroups: object

serializedName

serializedName: string = "properties.destinationApplicationSecurityGroups"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationSecurityGroup"

name

name: "Composite" = "Composite"

destinationPortRange

destinationPortRange: object

serializedName

serializedName: string = "properties.destinationPortRange"

type

type: object

name

name: "String" = "String"

destinationPortRanges

destinationPortRanges: object

serializedName

serializedName: string = "properties.destinationPortRanges"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

direction

direction: object

required

required: true = true

serializedName

serializedName: string = "properties.direction"

type

type: object

name

name: "String" = "String"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

priority

priority: object

serializedName

serializedName: string = "properties.priority"

type

type: object

name

name: "Number" = "Number"

protocol

protocol: object

required

required: true = true

serializedName

serializedName: string = "properties.protocol"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

sourceAddressPrefix

sourceAddressPrefix: object

serializedName

serializedName: string = "properties.sourceAddressPrefix"

type

type: object

name

name: "String" = "String"

sourceAddressPrefixes

sourceAddressPrefixes: object

serializedName

serializedName: string = "properties.sourceAddressPrefixes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

sourceApplicationSecurityGroups

sourceApplicationSecurityGroups: object

serializedName

serializedName: string = "properties.sourceApplicationSecurityGroups"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationSecurityGroup"

name

name: "Composite" = "Composite"

sourcePortRange

sourcePortRange: object

serializedName

serializedName: string = "properties.sourcePortRange"

type

type: object

name

name: "String" = "String"

sourcePortRanges

sourcePortRanges: object

serializedName

serializedName: string = "properties.sourcePortRanges"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const SecurityRuleAssociations

SecurityRuleAssociations: object

All security rules associated with the network interface.

Optional defaultSecurityRules

defaultSecurityRules: SecurityRule[]

Collection of default security rules of the network security group.

Optional effectiveSecurityRules

effectiveSecurityRules: EffectiveNetworkSecurityRule[]

Collection of effective security rules.

Optional networkInterfaceAssociation

networkInterfaceAssociation: NetworkInterfaceAssociation

Network interface and it's custom security rules.

serializedName

serializedName: string = "SecurityRuleAssociations"

Optional subnetAssociation

subnetAssociation: SubnetAssociation

Subnet and it's custom security rules.

type

type: object

className

className: string = "SecurityRuleAssociations"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

defaultSecurityRules

defaultSecurityRules: object

serializedName

serializedName: string = "defaultSecurityRules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SecurityRule"

name

name: "Composite" = "Composite"

effectiveSecurityRules

effectiveSecurityRules: object

serializedName

serializedName: string = "effectiveSecurityRules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "EffectiveNetworkSecurityRule"

name

name: "Composite" = "Composite"

networkInterfaceAssociation

networkInterfaceAssociation: object

serializedName

serializedName: string = "networkInterfaceAssociation"

type

type: object

className

className: string = "NetworkInterfaceAssociation"

name

name: "Composite" = "Composite"

subnetAssociation

subnetAssociation: object

serializedName

serializedName: string = "subnetAssociation"

type

type: object

className

className: string = "SubnetAssociation"

name

name: "Composite" = "Composite"

Const SecurityRuleListResult

SecurityRuleListResult: object
interface

Response for ListSecurityRule API service call. Retrieves all security rules that belongs to a network security group.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "SecurityRuleListResult"

__@iterator

  • __@iterator(): IterableIterator<SecurityRule>
  • Iterator

    Returns IterableIterator<SecurityRule>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<SecurityRule>[]): SecurityRule[]
  • concat(...items: (T | ConcatArray<T>)[]): SecurityRule[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<SecurityRule>[]

      Additional items to add to the end of array1.

    Returns SecurityRule[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns SecurityRule[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, SecurityRule]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, SecurityRule]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: SecurityRule, index: number, array: SecurityRule[]): boolean
        • Parameters

          • value: SecurityRule
          • index: number
          • array: SecurityRule[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: SecurityRule, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: SecurityRule

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): SecurityRule[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: SecurityRule

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: SecurityRule, index: number, array: SecurityRule[]): boolean
        • Parameters

          • value: SecurityRule
          • index: number
          • array: SecurityRule[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: SecurityRule, index: number, array: SecurityRule[]): any
        • Parameters

          • value: SecurityRule
          • index: number
          • array: SecurityRule[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns SecurityRule[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): SecurityRule | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: SecurityRule

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: SecurityRule, index: number, obj: SecurityRule[]): boolean
        • Parameters

          • this: void
          • value: SecurityRule
          • index: number
          • obj: SecurityRule[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: SecurityRule, index: number, obj: SecurityRule[]): boolean
        • Parameters

          • value: SecurityRule
          • index: number
          • obj: SecurityRule[]

          Returns boolean

    • Optional thisArg: any

    Returns SecurityRule | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: SecurityRule, index: number, obj: SecurityRule[]): boolean
        • Parameters

          • value: SecurityRule
          • index: number
          • obj: SecurityRule[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: SecurityRule, index: number, array: SecurityRule[]): void
        • Parameters

          • value: SecurityRule
          • index: number
          • array: SecurityRule[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: SecurityRule, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: SecurityRule

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: SecurityRule, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: SecurityRule

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: SecurityRule, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: SecurityRule

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: SecurityRule, index: number, array: SecurityRule[]): U
        • Parameters

          • value: SecurityRule
          • index: number
          • array: SecurityRule[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): SecurityRule | undefined
  • Removes the last element from an array and returns it.

    Returns SecurityRule | undefined

push

  • push(...items: SecurityRule[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: SecurityRule[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): SecurityRule
  • reduce(callbackfn: function, initialValue: SecurityRule): SecurityRule
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: SecurityRule, currentValue: SecurityRule, currentIndex: number, array: SecurityRule[]): SecurityRule
        • Parameters

          • previousValue: SecurityRule
          • currentValue: SecurityRule
          • currentIndex: number
          • array: SecurityRule[]

          Returns SecurityRule

    Returns SecurityRule

  • Parameters

    • callbackfn: function
        • (previousValue: SecurityRule, currentValue: SecurityRule, currentIndex: number, array: SecurityRule[]): SecurityRule
        • Parameters

          • previousValue: SecurityRule
          • currentValue: SecurityRule
          • currentIndex: number
          • array: SecurityRule[]

          Returns SecurityRule

    • initialValue: SecurityRule

    Returns SecurityRule

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: SecurityRule, currentIndex: number, array: SecurityRule[]): U
        • Parameters

          • previousValue: U
          • currentValue: SecurityRule
          • currentIndex: number
          • array: SecurityRule[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): SecurityRule
  • reduceRight(callbackfn: function, initialValue: SecurityRule): SecurityRule
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: SecurityRule, currentValue: SecurityRule, currentIndex: number, array: SecurityRule[]): SecurityRule
        • Parameters

          • previousValue: SecurityRule
          • currentValue: SecurityRule
          • currentIndex: number
          • array: SecurityRule[]

          Returns SecurityRule

    Returns SecurityRule

  • Parameters

    • callbackfn: function
        • (previousValue: SecurityRule, currentValue: SecurityRule, currentIndex: number, array: SecurityRule[]): SecurityRule
        • Parameters

          • previousValue: SecurityRule
          • currentValue: SecurityRule
          • currentIndex: number
          • array: SecurityRule[]

          Returns SecurityRule

    • initialValue: SecurityRule

    Returns SecurityRule

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: SecurityRule, currentIndex: number, array: SecurityRule[]): U
        • Parameters

          • previousValue: U
          • currentValue: SecurityRule
          • currentIndex: number
          • array: SecurityRule[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): SecurityRule[]
  • Reverses the elements in an Array.

    Returns SecurityRule[]

shift

  • shift(): SecurityRule | undefined
  • Removes the first element from an array and returns it.

    Returns SecurityRule | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): SecurityRule[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns SecurityRule[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: SecurityRule, index: number, array: SecurityRule[]): boolean
        • Parameters

          • value: SecurityRule
          • index: number
          • array: SecurityRule[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): SecurityRule[]
  • splice(start: number, deleteCount: number, ...items: SecurityRule[]): SecurityRule[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns SecurityRule[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: SecurityRule[]

      Elements to insert into the array in place of the deleted elements.

    Returns SecurityRule[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: SecurityRule[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: SecurityRule[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<SecurityRule>
  • Returns an iterable of values in the array

    Returns IterableIterator<SecurityRule>

type

type: object

className

className: string = "SecurityRuleListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SecurityRule"

name

name: "Composite" = "Composite"

Const ServiceAssociationLink

ServiceAssociationLink: object

ServiceAssociationLink resource.

Optional allowDelete

allowDelete: undefined | false | true

If true, the resource can be deleted.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID.

Optional link

link: undefined | string

Link to the external resource.

Optional linkedResourceType

linkedResourceType: undefined | string

Resource type of the linked resource.

Optional locations

locations: string[]

A list of locations.

Optional name

name: undefined | string

Name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional provisioningState

provisioningState: undefined | string

Provisioning state of the ServiceAssociationLink resource. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ServiceAssociationLink"

type

type: object

Resource type.

className

className: string = "ServiceAssociationLink"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

allowDelete

allowDelete: object

serializedName

serializedName: string = "properties.allowDelete"

type

type: object

name

name: "Boolean" = "Boolean"

etag

etag: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

link

link: object

serializedName

serializedName: string = "properties.link"

type

type: object

name

name: "String" = "String"

linkedResourceType

linkedResourceType: object

serializedName

serializedName: string = "properties.linkedResourceType"

type

type: object

name

name: "String" = "String"

locations

locations: object

serializedName

serializedName: string = "properties.locations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const ServiceAssociationLinksListResult

ServiceAssociationLinksListResult: object

Response for ServiceAssociationLinks_List operation.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ServiceAssociationLinksListResult"

Optional value

value: ServiceAssociationLink[]

The service association links in a subnet.

type

type: object

className

className: string = "ServiceAssociationLinksListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ServiceAssociationLink"

name

name: "Composite" = "Composite"

Const ServiceEndpointPolicy

ServiceEndpointPolicy: object

Service End point policy resource.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the service endpoint policy. Possible values are: 'Updating', 'Deleting', and 'Failed'. NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceGuid

resourceGuid: undefined | string

The resource GUID property of the service endpoint policy resource. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ServiceEndpointPolicy"

Optional serviceEndpointPolicyDefinitions

serviceEndpointPolicyDefinitions: ServiceEndpointPolicyDefinition[]

A collection of service endpoint policy definitions of the service endpoint policy.

Optional subnets

subnets: Subnet[]

A collection of references to subnets. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object

Resource tags.

type

type: object

className

className: string = "ServiceEndpointPolicy"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

resourceGuid

resourceGuid: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.resourceGuid"

type

type: object

name

name: "String" = "String"

serviceEndpointPolicyDefinitions

serviceEndpointPolicyDefinitions: object

serializedName

serializedName: string = "properties.serviceEndpointPolicyDefinitions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ServiceEndpointPolicyDefinition"

name

name: "Composite" = "Composite"

subnets

subnets: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.subnets"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Subnet"

name

name: "Composite" = "Composite"

Const ServiceEndpointPolicyDefinition

ServiceEndpointPolicyDefinition: object

Service Endpoint policy definitions.

Optional description

description: undefined | string

A description for this rule. Restricted to 140 chars.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the service end point policy definition. Possible values are: 'Updating', 'Deleting', and 'Failed'. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ServiceEndpointPolicyDefinition"

Optional service

service: undefined | string

Service endpoint name.

Optional serviceResources

serviceResources: string[]

A list of service resources.

type

type: object

className

className: string = "ServiceEndpointPolicyDefinition"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

service

service: object

serializedName

serializedName: string = "properties.service"

type

type: object

name

name: "String" = "String"

serviceResources

serviceResources: object

serializedName

serializedName: string = "properties.serviceResources"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const ServiceEndpointPolicyDefinitionListResult

ServiceEndpointPolicyDefinitionListResult: object
interface

Response for ListServiceEndpointPolicyDefinition API service call. Retrieves all service endpoint policy definition that belongs to a service endpoint policy.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "ServiceEndpointPolicyDefinitionListResult"

__@iterator

  • __@iterator(): IterableIterator<ServiceEndpointPolicyDefinition>
  • Iterator

    Returns IterableIterator<ServiceEndpointPolicyDefinition>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ServiceEndpointPolicyDefinition>[]): ServiceEndpointPolicyDefinition[]
  • concat(...items: (T | ConcatArray<T>)[]): ServiceEndpointPolicyDefinition[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ServiceEndpointPolicyDefinition>[]

      Additional items to add to the end of array1.

    Returns ServiceEndpointPolicyDefinition[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ServiceEndpointPolicyDefinition[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ServiceEndpointPolicyDefinition]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ServiceEndpointPolicyDefinition]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ServiceEndpointPolicyDefinition, index: number, array: ServiceEndpointPolicyDefinition[]): boolean
        • Parameters

          • value: ServiceEndpointPolicyDefinition
          • index: number
          • array: ServiceEndpointPolicyDefinition[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ServiceEndpointPolicyDefinition, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ServiceEndpointPolicyDefinition

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ServiceEndpointPolicyDefinition[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ServiceEndpointPolicyDefinition

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ServiceEndpointPolicyDefinition, index: number, array: ServiceEndpointPolicyDefinition[]): boolean
        • Parameters

          • value: ServiceEndpointPolicyDefinition
          • index: number
          • array: ServiceEndpointPolicyDefinition[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ServiceEndpointPolicyDefinition, index: number, array: ServiceEndpointPolicyDefinition[]): any
        • Parameters

          • value: ServiceEndpointPolicyDefinition
          • index: number
          • array: ServiceEndpointPolicyDefinition[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ServiceEndpointPolicyDefinition[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ServiceEndpointPolicyDefinition | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ServiceEndpointPolicyDefinition

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ServiceEndpointPolicyDefinition, index: number, obj: ServiceEndpointPolicyDefinition[]): boolean
        • Parameters

          • this: void
          • value: ServiceEndpointPolicyDefinition
          • index: number
          • obj: ServiceEndpointPolicyDefinition[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ServiceEndpointPolicyDefinition, index: number, obj: ServiceEndpointPolicyDefinition[]): boolean
        • Parameters

          • value: ServiceEndpointPolicyDefinition
          • index: number
          • obj: ServiceEndpointPolicyDefinition[]

          Returns boolean

    • Optional thisArg: any

    Returns ServiceEndpointPolicyDefinition | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ServiceEndpointPolicyDefinition, index: number, obj: ServiceEndpointPolicyDefinition[]): boolean
        • Parameters

          • value: ServiceEndpointPolicyDefinition
          • index: number
          • obj: ServiceEndpointPolicyDefinition[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ServiceEndpointPolicyDefinition, index: number, array: ServiceEndpointPolicyDefinition[]): void
        • Parameters

          • value: ServiceEndpointPolicyDefinition
          • index: number
          • array: ServiceEndpointPolicyDefinition[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ServiceEndpointPolicyDefinition, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ServiceEndpointPolicyDefinition

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ServiceEndpointPolicyDefinition, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ServiceEndpointPolicyDefinition

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ServiceEndpointPolicyDefinition, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ServiceEndpointPolicyDefinition

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ServiceEndpointPolicyDefinition, index: number, array: ServiceEndpointPolicyDefinition[]): U
        • Parameters

          • value: ServiceEndpointPolicyDefinition
          • index: number
          • array: ServiceEndpointPolicyDefinition[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ServiceEndpointPolicyDefinition | undefined
  • Removes the last element from an array and returns it.

    Returns ServiceEndpointPolicyDefinition | undefined

push

  • push(...items: ServiceEndpointPolicyDefinition[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ServiceEndpointPolicyDefinition[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ServiceEndpointPolicyDefinition
  • reduce(callbackfn: function, initialValue: ServiceEndpointPolicyDefinition): ServiceEndpointPolicyDefinition
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ServiceEndpointPolicyDefinition, currentValue: ServiceEndpointPolicyDefinition, currentIndex: number, array: ServiceEndpointPolicyDefinition[]): ServiceEndpointPolicyDefinition
        • Parameters

          • previousValue: ServiceEndpointPolicyDefinition
          • currentValue: ServiceEndpointPolicyDefinition
          • currentIndex: number
          • array: ServiceEndpointPolicyDefinition[]

          Returns ServiceEndpointPolicyDefinition

    Returns ServiceEndpointPolicyDefinition

  • Parameters

    • callbackfn: function
        • (previousValue: ServiceEndpointPolicyDefinition, currentValue: ServiceEndpointPolicyDefinition, currentIndex: number, array: ServiceEndpointPolicyDefinition[]): ServiceEndpointPolicyDefinition
        • Parameters

          • previousValue: ServiceEndpointPolicyDefinition
          • currentValue: ServiceEndpointPolicyDefinition
          • currentIndex: number
          • array: ServiceEndpointPolicyDefinition[]

          Returns ServiceEndpointPolicyDefinition

    • initialValue: ServiceEndpointPolicyDefinition

    Returns ServiceEndpointPolicyDefinition

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ServiceEndpointPolicyDefinition, currentIndex: number, array: ServiceEndpointPolicyDefinition[]): U
        • Parameters

          • previousValue: U
          • currentValue: ServiceEndpointPolicyDefinition
          • currentIndex: number
          • array: ServiceEndpointPolicyDefinition[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ServiceEndpointPolicyDefinition
  • reduceRight(callbackfn: function, initialValue: ServiceEndpointPolicyDefinition): ServiceEndpointPolicyDefinition
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ServiceEndpointPolicyDefinition, currentValue: ServiceEndpointPolicyDefinition, currentIndex: number, array: ServiceEndpointPolicyDefinition[]): ServiceEndpointPolicyDefinition
        • Parameters

          • previousValue: ServiceEndpointPolicyDefinition
          • currentValue: ServiceEndpointPolicyDefinition
          • currentIndex: number
          • array: ServiceEndpointPolicyDefinition[]

          Returns ServiceEndpointPolicyDefinition

    Returns ServiceEndpointPolicyDefinition

  • Parameters

    • callbackfn: function
        • (previousValue: ServiceEndpointPolicyDefinition, currentValue: ServiceEndpointPolicyDefinition, currentIndex: number, array: ServiceEndpointPolicyDefinition[]): ServiceEndpointPolicyDefinition
        • Parameters

          • previousValue: ServiceEndpointPolicyDefinition
          • currentValue: ServiceEndpointPolicyDefinition
          • currentIndex: number
          • array: ServiceEndpointPolicyDefinition[]

          Returns ServiceEndpointPolicyDefinition

    • initialValue: ServiceEndpointPolicyDefinition

    Returns ServiceEndpointPolicyDefinition

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ServiceEndpointPolicyDefinition, currentIndex: number, array: ServiceEndpointPolicyDefinition[]): U
        • Parameters

          • previousValue: U
          • currentValue: ServiceEndpointPolicyDefinition
          • currentIndex: number
          • array: ServiceEndpointPolicyDefinition[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ServiceEndpointPolicyDefinition[]
  • Reverses the elements in an Array.

    Returns ServiceEndpointPolicyDefinition[]

shift

  • shift(): ServiceEndpointPolicyDefinition | undefined
  • Removes the first element from an array and returns it.

    Returns ServiceEndpointPolicyDefinition | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ServiceEndpointPolicyDefinition[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ServiceEndpointPolicyDefinition[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ServiceEndpointPolicyDefinition, index: number, array: ServiceEndpointPolicyDefinition[]): boolean
        • Parameters

          • value: ServiceEndpointPolicyDefinition
          • index: number
          • array: ServiceEndpointPolicyDefinition[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ServiceEndpointPolicyDefinition[]
  • splice(start: number, deleteCount: number, ...items: ServiceEndpointPolicyDefinition[]): ServiceEndpointPolicyDefinition[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ServiceEndpointPolicyDefinition[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ServiceEndpointPolicyDefinition[]

      Elements to insert into the array in place of the deleted elements.

    Returns ServiceEndpointPolicyDefinition[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ServiceEndpointPolicyDefinition[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ServiceEndpointPolicyDefinition[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ServiceEndpointPolicyDefinition>
  • Returns an iterable of values in the array

    Returns IterableIterator<ServiceEndpointPolicyDefinition>

type

type: object

className

className: string = "ServiceEndpointPolicyDefinitionListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ServiceEndpointPolicyDefinition"

name

name: "Composite" = "Composite"

Const ServiceEndpointPolicyListResult

ServiceEndpointPolicyListResult: object
interface

Response for ListServiceEndpointPolicies API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ServiceEndpointPolicyListResult"

__@iterator

  • __@iterator(): IterableIterator<ServiceEndpointPolicy>
  • Iterator

    Returns IterableIterator<ServiceEndpointPolicy>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ServiceEndpointPolicy>[]): ServiceEndpointPolicy[]
  • concat(...items: (T | ConcatArray<T>)[]): ServiceEndpointPolicy[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ServiceEndpointPolicy>[]

      Additional items to add to the end of array1.

    Returns ServiceEndpointPolicy[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ServiceEndpointPolicy[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ServiceEndpointPolicy]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ServiceEndpointPolicy]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ServiceEndpointPolicy, index: number, array: ServiceEndpointPolicy[]): boolean
        • Parameters

          • value: ServiceEndpointPolicy
          • index: number
          • array: ServiceEndpointPolicy[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ServiceEndpointPolicy, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ServiceEndpointPolicy

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ServiceEndpointPolicy[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ServiceEndpointPolicy

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ServiceEndpointPolicy, index: number, array: ServiceEndpointPolicy[]): boolean
        • Parameters

          • value: ServiceEndpointPolicy
          • index: number
          • array: ServiceEndpointPolicy[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ServiceEndpointPolicy, index: number, array: ServiceEndpointPolicy[]): any
        • Parameters

          • value: ServiceEndpointPolicy
          • index: number
          • array: ServiceEndpointPolicy[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ServiceEndpointPolicy[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ServiceEndpointPolicy | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ServiceEndpointPolicy

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ServiceEndpointPolicy, index: number, obj: ServiceEndpointPolicy[]): boolean
        • Parameters

          • this: void
          • value: ServiceEndpointPolicy
          • index: number
          • obj: ServiceEndpointPolicy[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ServiceEndpointPolicy, index: number, obj: ServiceEndpointPolicy[]): boolean
        • Parameters

          • value: ServiceEndpointPolicy
          • index: number
          • obj: ServiceEndpointPolicy[]

          Returns boolean

    • Optional thisArg: any

    Returns ServiceEndpointPolicy | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ServiceEndpointPolicy, index: number, obj: ServiceEndpointPolicy[]): boolean
        • Parameters

          • value: ServiceEndpointPolicy
          • index: number
          • obj: ServiceEndpointPolicy[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ServiceEndpointPolicy, index: number, array: ServiceEndpointPolicy[]): void
        • Parameters

          • value: ServiceEndpointPolicy
          • index: number
          • array: ServiceEndpointPolicy[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ServiceEndpointPolicy, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ServiceEndpointPolicy

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ServiceEndpointPolicy, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ServiceEndpointPolicy

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ServiceEndpointPolicy, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ServiceEndpointPolicy

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ServiceEndpointPolicy, index: number, array: ServiceEndpointPolicy[]): U
        • Parameters

          • value: ServiceEndpointPolicy
          • index: number
          • array: ServiceEndpointPolicy[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ServiceEndpointPolicy | undefined
  • Removes the last element from an array and returns it.

    Returns ServiceEndpointPolicy | undefined

push

  • push(...items: ServiceEndpointPolicy[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ServiceEndpointPolicy[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ServiceEndpointPolicy
  • reduce(callbackfn: function, initialValue: ServiceEndpointPolicy): ServiceEndpointPolicy
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ServiceEndpointPolicy, currentValue: ServiceEndpointPolicy, currentIndex: number, array: ServiceEndpointPolicy[]): ServiceEndpointPolicy
        • Parameters

          • previousValue: ServiceEndpointPolicy
          • currentValue: ServiceEndpointPolicy
          • currentIndex: number
          • array: ServiceEndpointPolicy[]

          Returns ServiceEndpointPolicy

    Returns ServiceEndpointPolicy

  • Parameters

    • callbackfn: function
        • (previousValue: ServiceEndpointPolicy, currentValue: ServiceEndpointPolicy, currentIndex: number, array: ServiceEndpointPolicy[]): ServiceEndpointPolicy
        • Parameters

          • previousValue: ServiceEndpointPolicy
          • currentValue: ServiceEndpointPolicy
          • currentIndex: number
          • array: ServiceEndpointPolicy[]

          Returns ServiceEndpointPolicy

    • initialValue: ServiceEndpointPolicy

    Returns ServiceEndpointPolicy

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ServiceEndpointPolicy, currentIndex: number, array: ServiceEndpointPolicy[]): U
        • Parameters

          • previousValue: U
          • currentValue: ServiceEndpointPolicy
          • currentIndex: number
          • array: ServiceEndpointPolicy[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ServiceEndpointPolicy
  • reduceRight(callbackfn: function, initialValue: ServiceEndpointPolicy): ServiceEndpointPolicy
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ServiceEndpointPolicy, currentValue: ServiceEndpointPolicy, currentIndex: number, array: ServiceEndpointPolicy[]): ServiceEndpointPolicy
        • Parameters

          • previousValue: ServiceEndpointPolicy
          • currentValue: ServiceEndpointPolicy
          • currentIndex: number
          • array: ServiceEndpointPolicy[]

          Returns ServiceEndpointPolicy

    Returns ServiceEndpointPolicy

  • Parameters

    • callbackfn: function
        • (previousValue: ServiceEndpointPolicy, currentValue: ServiceEndpointPolicy, currentIndex: number, array: ServiceEndpointPolicy[]): ServiceEndpointPolicy
        • Parameters

          • previousValue: ServiceEndpointPolicy
          • currentValue: ServiceEndpointPolicy
          • currentIndex: number
          • array: ServiceEndpointPolicy[]

          Returns ServiceEndpointPolicy

    • initialValue: ServiceEndpointPolicy

    Returns ServiceEndpointPolicy

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ServiceEndpointPolicy, currentIndex: number, array: ServiceEndpointPolicy[]): U
        • Parameters

          • previousValue: U
          • currentValue: ServiceEndpointPolicy
          • currentIndex: number
          • array: ServiceEndpointPolicy[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ServiceEndpointPolicy[]
  • Reverses the elements in an Array.

    Returns ServiceEndpointPolicy[]

shift

  • shift(): ServiceEndpointPolicy | undefined
  • Removes the first element from an array and returns it.

    Returns ServiceEndpointPolicy | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ServiceEndpointPolicy[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ServiceEndpointPolicy[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ServiceEndpointPolicy, index: number, array: ServiceEndpointPolicy[]): boolean
        • Parameters

          • value: ServiceEndpointPolicy
          • index: number
          • array: ServiceEndpointPolicy[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ServiceEndpointPolicy[]
  • splice(start: number, deleteCount: number, ...items: ServiceEndpointPolicy[]): ServiceEndpointPolicy[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ServiceEndpointPolicy[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ServiceEndpointPolicy[]

      Elements to insert into the array in place of the deleted elements.

    Returns ServiceEndpointPolicy[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ServiceEndpointPolicy[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ServiceEndpointPolicy[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ServiceEndpointPolicy>
  • Returns an iterable of values in the array

    Returns IterableIterator<ServiceEndpointPolicy>

type

type: object

className

className: string = "ServiceEndpointPolicyListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ServiceEndpointPolicy"

name

name: "Composite" = "Composite"

Const ServiceEndpointPropertiesFormat

ServiceEndpointPropertiesFormat: object

The service endpoint properties.

Optional locations

locations: string[]

A list of locations.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the resource.

serializedName

serializedName: string = "ServiceEndpointPropertiesFormat"

Optional service

service: undefined | string

The type of the endpoint service.

type

type: object

className

className: string = "ServiceEndpointPropertiesFormat"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

locations

locations: object

serializedName

serializedName: string = "locations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "provisioningState"

type

type: object

name

name: "String" = "String"

service

service: object

serializedName

serializedName: string = "service"

type

type: object

name

name: "String" = "String"

Const ServiceTagInformation

ServiceTagInformation: object

The service tag information.

Optional id

id: undefined | string

The ID of service tag. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

The name of service tag. NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

Properties of the service tag information. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ServiceTagInformation"

type

type: object

className

className: string = "ServiceTagInformation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

properties

properties: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "ServiceTagInformationPropertiesFormat"

name

name: "Composite" = "Composite"

Const ServiceTagInformationPropertiesFormat

ServiceTagInformationPropertiesFormat: object

Properties of the service tag information.

Optional addressPrefixes

addressPrefixes: string[]

The list of IP address prefixes. NOTE: This property will not be serialized. It can only be populated by the server.

Optional changeNumber

changeNumber: undefined | string

The iteration number of service tag. NOTE: This property will not be serialized. It can only be populated by the server.

Optional region

region: undefined | string

The region of service tag. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ServiceTagInformationPropertiesFormat"

Optional systemService

systemService: undefined | string

The name of system service. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "ServiceTagInformationPropertiesFormat"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

addressPrefixes

addressPrefixes: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "addressPrefixes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

changeNumber

changeNumber: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "changeNumber"

type

type: object

name

name: "String" = "String"

region

region: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "region"

type

type: object

name

name: "String" = "String"

systemService

systemService: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "systemService"

type

type: object

name

name: "String" = "String"

Const ServiceTagsListResult

ServiceTagsListResult: object

Response for the ListServiceTags API service call.

Optional changeNumber

changeNumber: undefined | string

The iteration number. NOTE: This property will not be serialized. It can only be populated by the server.

Optional cloud

cloud: undefined | string

The name of the cloud. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

The ID of the cloud. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

The name of the cloud. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ServiceTagsListResult"

Optional values

values: ServiceTagInformation[]

The list of service tag information resources. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

The azure resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "ServiceTagsListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

changeNumber

changeNumber: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "changeNumber"

type

type: object

name

name: "String" = "String"

cloud

cloud: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "cloud"

type

type: object

name

name: "String" = "String"

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

values

values: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "values"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ServiceTagInformation"

name

name: "Composite" = "Composite"

Const SubResource

SubResource: object

Reference to another subresource.

Optional id

id: undefined | string

Resource ID.

serializedName

serializedName: string = "SubResource"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

Const Subnet

Subnet: object

Subnet in a virtual network resource.

Optional addressPrefix

addressPrefix: undefined | string

The address prefix for the subnet.

Optional addressPrefixes

addressPrefixes: string[]

List of address prefixes for the subnet.

Optional delegations

delegations: Delegation[]

Gets an array of references to the delegations on the subnet.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional ipConfigurationProfiles

ipConfigurationProfiles: IPConfigurationProfile[]

Array of IP configuration profiles which reference this subnet. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ipConfigurations

ipConfigurations: IPConfiguration[]

Gets an array of references to the network interface IP configurations using subnet. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional natGateway

natGateway: SubResource

Nat gateway associated with this subnet.

Optional networkSecurityGroup

networkSecurityGroup: NetworkSecurityGroup

The reference of the NetworkSecurityGroup resource.

Optional privateEndpoints

privateEndpoints: PrivateEndpoint[]

An array of references to private endpoints. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the resource.

Optional purpose

purpose: undefined | string

A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceNavigationLinks

resourceNavigationLinks: ResourceNavigationLink[]

Gets an array of references to the external resources using subnet.

Optional routeTable

routeTable: RouteTable

The reference of the RouteTable resource.

serializedName

serializedName: string = "Subnet"

Optional serviceAssociationLinks

serviceAssociationLinks: ServiceAssociationLink[]

Gets an array of references to services injecting into this subnet.

Optional serviceEndpointPolicies

serviceEndpointPolicies: ServiceEndpointPolicy[]

An array of service endpoint policies.

Optional serviceEndpoints

serviceEndpoints: ServiceEndpointPropertiesFormat[]

An array of service endpoints.

type

type: object

className

className: string = "Subnet"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

addressPrefix

addressPrefix: object

serializedName

serializedName: string = "properties.addressPrefix"

type

type: object

name

name: "String" = "String"

addressPrefixes

addressPrefixes: object

serializedName

serializedName: string = "properties.addressPrefixes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

delegations

delegations: object

serializedName

serializedName: string = "properties.delegations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Delegation"

name

name: "Composite" = "Composite"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

ipConfigurationProfiles

ipConfigurationProfiles: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.ipConfigurationProfiles"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "IPConfigurationProfile"

name

name: "Composite" = "Composite"

ipConfigurations

ipConfigurations: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.ipConfigurations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "IPConfiguration"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

natGateway

natGateway: object

serializedName

serializedName: string = "properties.natGateway"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

networkSecurityGroup

networkSecurityGroup: object

serializedName

serializedName: string = "properties.networkSecurityGroup"

type

type: object

className

className: string = "NetworkSecurityGroup"

name

name: "Composite" = "Composite"

privateEndpoints

privateEndpoints: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.privateEndpoints"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PrivateEndpoint"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

purpose

purpose: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.purpose"

type

type: object

name

name: "String" = "String"

resourceNavigationLinks

resourceNavigationLinks: object

serializedName

serializedName: string = "properties.resourceNavigationLinks"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ResourceNavigationLink"

name

name: "Composite" = "Composite"

routeTable

routeTable: object

serializedName

serializedName: string = "properties.routeTable"

type

type: object

className

className: string = "RouteTable"

name

name: "Composite" = "Composite"

serviceAssociationLinks

serviceAssociationLinks: object

serializedName

serializedName: string = "properties.serviceAssociationLinks"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ServiceAssociationLink"

name

name: "Composite" = "Composite"

serviceEndpointPolicies

serviceEndpointPolicies: object

serializedName

serializedName: string = "properties.serviceEndpointPolicies"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ServiceEndpointPolicy"

name

name: "Composite" = "Composite"

serviceEndpoints

serviceEndpoints: object

serializedName

serializedName: string = "properties.serviceEndpoints"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ServiceEndpointPropertiesFormat"

name

name: "Composite" = "Composite"

Const SubnetAssociation

SubnetAssociation: object

Subnet and it's custom security rules.

Optional id

id: undefined | string

Subnet ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional securityRules

securityRules: SecurityRule[]

Collection of custom security rules.

serializedName

serializedName: string = "SubnetAssociation"

type

type: object

className

className: string = "SubnetAssociation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

securityRules

securityRules: object

serializedName

serializedName: string = "securityRules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SecurityRule"

name

name: "Composite" = "Composite"

Const SubnetListResult

SubnetListResult: object
interface

Response for ListSubnets API service callRetrieves all subnet that belongs to a virtual network.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "SubnetListResult"

__@iterator

  • __@iterator(): IterableIterator<Subnet>
  • Iterator

    Returns IterableIterator<Subnet>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Subnet>[]): Subnet[]
  • concat(...items: (T | ConcatArray<T>)[]): Subnet[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Subnet>[]

      Additional items to add to the end of array1.

    Returns Subnet[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Subnet[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Subnet]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Subnet]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: Subnet, index: number, array: Subnet[]): boolean
        • Parameters

          • value: Subnet
          • index: number
          • array: Subnet[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Subnet, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Subnet

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Subnet[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: Subnet

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Subnet, index: number, array: Subnet[]): boolean
        • Parameters

          • value: Subnet
          • index: number
          • array: Subnet[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Subnet, index: number, array: Subnet[]): any
        • Parameters

          • value: Subnet
          • index: number
          • array: Subnet[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Subnet[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Subnet | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: Subnet

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Subnet, index: number, obj: Subnet[]): boolean
        • Parameters

          • this: void
          • value: Subnet
          • index: number
          • obj: Subnet[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: Subnet, index: number, obj: Subnet[]): boolean
        • Parameters

          • value: Subnet
          • index: number
          • obj: Subnet[]

          Returns boolean

    • Optional thisArg: any

    Returns Subnet | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: Subnet, index: number, obj: Subnet[]): boolean
        • Parameters

          • value: Subnet
          • index: number
          • obj: Subnet[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: Subnet, index: number, array: Subnet[]): void
        • Parameters

          • value: Subnet
          • index: number
          • array: Subnet[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Subnet, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Subnet

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Subnet, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Subnet

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Subnet, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Subnet

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: Subnet, index: number, array: Subnet[]): U
        • Parameters

          • value: Subnet
          • index: number
          • array: Subnet[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): Subnet | undefined
  • Removes the last element from an array and returns it.

    Returns Subnet | undefined

push

  • push(...items: Subnet[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Subnet[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Subnet
  • reduce(callbackfn: function, initialValue: Subnet): Subnet
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: Subnet, currentValue: Subnet, currentIndex: number, array: Subnet[]): Subnet
        • Parameters

          • previousValue: Subnet
          • currentValue: Subnet
          • currentIndex: number
          • array: Subnet[]

          Returns Subnet

    Returns Subnet

  • Parameters

    • callbackfn: function
        • (previousValue: Subnet, currentValue: Subnet, currentIndex: number, array: Subnet[]): Subnet
        • Parameters

          • previousValue: Subnet
          • currentValue: Subnet
          • currentIndex: number
          • array: Subnet[]

          Returns Subnet

    • initialValue: Subnet

    Returns Subnet

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Subnet, currentIndex: number, array: Subnet[]): U
        • Parameters

          • previousValue: U
          • currentValue: Subnet
          • currentIndex: number
          • array: Subnet[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Subnet
  • reduceRight(callbackfn: function, initialValue: Subnet): Subnet
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: Subnet, currentValue: Subnet, currentIndex: number, array: Subnet[]): Subnet
        • Parameters

          • previousValue: Subnet
          • currentValue: Subnet
          • currentIndex: number
          • array: Subnet[]

          Returns Subnet

    Returns Subnet

  • Parameters

    • callbackfn: function
        • (previousValue: Subnet, currentValue: Subnet, currentIndex: number, array: Subnet[]): Subnet
        • Parameters

          • previousValue: Subnet
          • currentValue: Subnet
          • currentIndex: number
          • array: Subnet[]

          Returns Subnet

    • initialValue: Subnet

    Returns Subnet

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Subnet, currentIndex: number, array: Subnet[]): U
        • Parameters

          • previousValue: U
          • currentValue: Subnet
          • currentIndex: number
          • array: Subnet[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): Subnet[]
  • Reverses the elements in an Array.

    Returns Subnet[]

shift

  • shift(): Subnet | undefined
  • Removes the first element from an array and returns it.

    Returns Subnet | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Subnet[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Subnet[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: Subnet, index: number, array: Subnet[]): boolean
        • Parameters

          • value: Subnet
          • index: number
          • array: Subnet[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Subnet[]
  • splice(start: number, deleteCount: number, ...items: Subnet[]): Subnet[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Subnet[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Subnet[]

      Elements to insert into the array in place of the deleted elements.

    Returns Subnet[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Subnet[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Subnet[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Subnet>
  • Returns an iterable of values in the array

    Returns IterableIterator<Subnet>

type

type: object

className

className: string = "SubnetListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Subnet"

name

name: "Composite" = "Composite"

Const TagsObject

TagsObject: object

Tags object for patch operations.

serializedName

serializedName: string = "TagsObject"

Optional tags

tags: undefined | object

Resource tags.

type

type: object

className

className: string = "TagsObject"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

Const Topology

Topology: object

Topology of the specified resource group.

Optional createdDateTime

createdDateTime: Date

The datetime when the topology was initially created for the resource group. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

GUID representing the operation id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastModified

lastModified: Date

The datetime when the topology was last modified. NOTE: This property will not be serialized. It can only be populated by the server.

Optional resources

resources: TopologyResource[]

A list of topology resources.

serializedName

serializedName: string = "Topology"

type

type: object

className

className: string = "Topology"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

createdDateTime

createdDateTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "createdDateTime"

type

type: object

name

name: "DateTime" = "DateTime"

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "lastModified"

type

type: object

name

name: "DateTime" = "DateTime"

resources

resources: object

serializedName

serializedName: string = "resources"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "TopologyResource"

name

name: "Composite" = "Composite"

Const TopologyAssociation

TopologyAssociation: object

Resources that have an association with the parent resource.

Optional associationType

associationType: AssociationType

The association type of the child resource to the parent resource. Possible values include: 'Associated', 'Contains'

Optional name

name: undefined | string

The name of the resource that is associated with the parent resource.

Optional resourceId

resourceId: undefined | string

The ID of the resource that is associated with the parent resource.

serializedName

serializedName: string = "TopologyAssociation"

type

type: object

className

className: string = "TopologyAssociation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

associationType

associationType: object

serializedName

serializedName: string = "associationType"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

resourceId

resourceId: object

serializedName

serializedName: string = "resourceId"

type

type: object

name

name: "String" = "String"

Const TopologyParameters

TopologyParameters: object

Parameters that define the representation of topology.

serializedName

serializedName: string = "TopologyParameters"

Optional targetResourceGroupName

targetResourceGroupName: undefined | string

The name of the target resource group to perform topology on.

Optional targetSubnet

targetSubnet: SubResource

The reference of the Subnet resource.

Optional targetVirtualNetwork

targetVirtualNetwork: SubResource

The reference of the Virtual Network resource.

type

type: object

className

className: string = "TopologyParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

targetResourceGroupName

targetResourceGroupName: object

serializedName

serializedName: string = "targetResourceGroupName"

type

type: object

name

name: "String" = "String"

targetSubnet

targetSubnet: object

serializedName

serializedName: string = "targetSubnet"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

targetVirtualNetwork

targetVirtualNetwork: object

serializedName

serializedName: string = "targetVirtualNetwork"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

Const TopologyResource

TopologyResource: object

The network resource topology information for the given resource group.

Optional associations

associations: TopologyAssociation[]

Holds the associations the resource has with other resources in the resource group.

Optional id

id: undefined | string

ID of the resource.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Name of the resource.

serializedName

serializedName: string = "TopologyResource"

type

type: object

className

className: string = "TopologyResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

associations

associations: object

serializedName

serializedName: string = "associations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "TopologyAssociation"

name

name: "Composite" = "Composite"

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const TrafficAnalyticsConfigurationProperties

TrafficAnalyticsConfigurationProperties: object

Parameters that define the configuration of traffic analytics.

enabled

enabled: boolean

Flag to enable/disable traffic analytics.

serializedName

serializedName: string = "TrafficAnalyticsConfigurationProperties"

Optional trafficAnalyticsInterval

trafficAnalyticsInterval: undefined | number

The interval in minutes which would decide how frequently TA service should do flow analytics.

workspaceId

workspaceId: string

The resource guid of the attached workspace.

workspaceRegion

workspaceRegion: string

The location of the attached workspace.

workspaceResourceId

workspaceResourceId: string

Resource Id of the attached workspace.

type

type: object

className

className: string = "TrafficAnalyticsConfigurationProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

enabled

enabled: object

required

required: true = true

serializedName

serializedName: string = "enabled"

type

type: object

name

name: "Boolean" = "Boolean"

trafficAnalyticsInterval

trafficAnalyticsInterval: object

serializedName

serializedName: string = "trafficAnalyticsInterval"

type

type: object

name

name: "Number" = "Number"

workspaceId

workspaceId: object

required

required: true = true

serializedName

serializedName: string = "workspaceId"

type

type: object

name

name: "String" = "String"

workspaceRegion

workspaceRegion: object

required

required: true = true

serializedName

serializedName: string = "workspaceRegion"

type

type: object

name

name: "String" = "String"

workspaceResourceId

workspaceResourceId: object

required

required: true = true

serializedName

serializedName: string = "workspaceResourceId"

type

type: object

name

name: "String" = "String"

Const TrafficAnalyticsProperties

TrafficAnalyticsProperties: object

Parameters that define the configuration of traffic analytics.

networkWatcherFlowAnalyticsConfiguration

networkWatcherFlowAnalyticsConfiguration: TrafficAnalyticsConfigurationProperties

Parameters that define the configuration of traffic analytics.

serializedName

serializedName: string = "TrafficAnalyticsProperties"

type

type: object

className

className: string = "TrafficAnalyticsProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

networkWatcherFlowAnalyticsConfiguration

networkWatcherFlowAnalyticsConfiguration: object

required

required: true = true

serializedName

serializedName: string = "networkWatcherFlowAnalyticsConfiguration"

type

type: object

className

className: string = "TrafficAnalyticsConfigurationProperties"

name

name: "Composite" = "Composite"

Const TroubleshootingDetails

TroubleshootingDetails: object

Information gained from troubleshooting of specified resource.

Optional detail

detail: undefined | string

Details on troubleshooting results.

Optional id

id: undefined | string

The id of the get troubleshoot operation.

Optional reasonType

reasonType: undefined | string

Reason type of failure.

Optional recommendedActions

recommendedActions: TroubleshootingRecommendedActions[]

List of recommended actions.

serializedName

serializedName: string = "TroubleshootingDetails"

Optional summary

summary: undefined | string

A summary of troubleshooting.

type

type: object

className

className: string = "TroubleshootingDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

detail

detail: object

serializedName

serializedName: string = "detail"

type

type: object

name

name: "String" = "String"

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

reasonType

reasonType: object

serializedName

serializedName: string = "reasonType"

type

type: object

name

name: "String" = "String"

recommendedActions

recommendedActions: object

serializedName

serializedName: string = "recommendedActions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "TroubleshootingRecommendedActions"

name

name: "Composite" = "Composite"

summary

summary: object

serializedName

serializedName: string = "summary"

type

type: object

name

name: "String" = "String"

Const TroubleshootingParameters

TroubleshootingParameters: object

Parameters that define the resource to troubleshoot.

serializedName

serializedName: string = "TroubleshootingParameters"

storageId

storageId: string

The ID for the storage account to save the troubleshoot result.

storagePath

storagePath: string

The path to the blob to save the troubleshoot result in.

targetResourceId

targetResourceId: string

The target resource to troubleshoot.

type

type: object

className

className: string = "TroubleshootingParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

storageId

storageId: object

required

required: true = true

serializedName

serializedName: string = "properties.storageId"

type

type: object

name

name: "String" = "String"

storagePath

storagePath: object

required

required: true = true

serializedName

serializedName: string = "properties.storagePath"

type

type: object

name

name: "String" = "String"

targetResourceId

targetResourceId: object

required

required: true = true

serializedName

serializedName: string = "targetResourceId"

type

type: object

name

name: "String" = "String"

Const TroubleshootingRecommendedActions

TroubleshootingRecommendedActions: object

Recommended actions based on discovered issues.

Optional actionId

actionId: undefined | string

ID of the recommended action.

Optional actionText

actionText: undefined | string

Description of recommended actions.

Optional actionUri

actionUri: undefined | string

The uri linking to a documentation for the recommended troubleshooting actions.

Optional actionUriText

actionUriText: undefined | string

The information from the URI for the recommended troubleshooting actions.

serializedName

serializedName: string = "TroubleshootingRecommendedActions"

type

type: object

className

className: string = "TroubleshootingRecommendedActions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

actionId

actionId: object

serializedName

serializedName: string = "actionId"

type

type: object

name

name: "String" = "String"

actionText

actionText: object

serializedName

serializedName: string = "actionText"

type

type: object

name

name: "String" = "String"

actionUri

actionUri: object

serializedName

serializedName: string = "actionUri"

type

type: object

name

name: "String" = "String"

actionUriText

actionUriText: object

serializedName

serializedName: string = "actionUriText"

type

type: object

name

name: "String" = "String"

Const TroubleshootingResult

TroubleshootingResult: object

Troubleshooting information gained from specified resource.

Optional code

code: undefined | string

The result code of the troubleshooting.

Optional endTime

endTime: Date

The end time of the troubleshooting.

Optional results

results: TroubleshootingDetails[]

Information from troubleshooting.

serializedName

serializedName: string = "TroubleshootingResult"

Optional startTime

startTime: Date

The start time of the troubleshooting.

type

type: object

className

className: string = "TroubleshootingResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

endTime

endTime: object

serializedName

serializedName: string = "endTime"

type

type: object

name

name: "DateTime" = "DateTime"

results

results: object

serializedName

serializedName: string = "results"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "TroubleshootingDetails"

name

name: "Composite" = "Composite"

startTime

startTime: object

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

Const TunnelConnectionHealth

TunnelConnectionHealth: object

VirtualNetworkGatewayConnection properties.

Optional connectionStatus

Virtual Network Gateway connection status. Possible values include: 'Unknown', 'Connecting', 'Connected', 'NotConnected' NOTE: This property will not be serialized. It can only be populated by the server.

Optional egressBytesTransferred

egressBytesTransferred: undefined | number

The Egress Bytes Transferred in this connection. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ingressBytesTransferred

ingressBytesTransferred: undefined | number

The Ingress Bytes Transferred in this connection. NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastConnectionEstablishedUtcTime

lastConnectionEstablishedUtcTime: undefined | string

The time at which connection was established in Utc format. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "TunnelConnectionHealth"

Optional tunnel

tunnel: undefined | string

Tunnel name. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "TunnelConnectionHealth"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

connectionStatus

connectionStatus: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "connectionStatus"

type

type: object

name

name: "String" = "String"

egressBytesTransferred

egressBytesTransferred: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "egressBytesTransferred"

type

type: object

name

name: "Number" = "Number"

ingressBytesTransferred

ingressBytesTransferred: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "ingressBytesTransferred"

type

type: object

name

name: "Number" = "Number"

lastConnectionEstablishedUtcTime

lastConnectionEstablishedUtcTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "lastConnectionEstablishedUtcTime"

type

type: object

name

name: "String" = "String"

tunnel

tunnel: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "tunnel"

type

type: object

name

name: "String" = "String"

Const Usage

Usage: object

Describes network resource usage.

currentValue

currentValue: number

The current value of the usage.

Optional id

id: undefined | string

Resource identifier. NOTE: This property will not be serialized. It can only be populated by the server.

limit

limit: number

The limit of usage.

name

name: UsageName

The name of the type of usage.

serializedName

serializedName: string = "Usage"

type

type: object

className

className: string = "Usage"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

currentValue

currentValue: object

required

required: true = true

serializedName

serializedName: string = "currentValue"

type

type: object

name

name: "Number" = "Number"

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

limit

limit: object

required

required: true = true

serializedName

serializedName: string = "limit"

type

type: object

name

name: "Number" = "Number"

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

className

className: string = "UsageName"

name

name: "Composite" = "Composite"

unit

unit: object

defaultValue

defaultValue: string = "Count"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "unit"

type

type: object

name

name: "String" = "String"

Const UsageName

UsageName: object

The usage names.

Optional localizedValue

localizedValue: undefined | string

A localized string describing the resource name.

serializedName

serializedName: string = "UsageName"

Optional value

value: undefined | string

A string describing the resource name.

type

type: object

className

className: string = "UsageName"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

localizedValue

localizedValue: object

serializedName

serializedName: string = "localizedValue"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const UsagesListResult

UsagesListResult: object
interface

The list usages operation response.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

URL to get the next set of results.

serializedName

serializedName: string = "UsagesListResult"

__@iterator

  • __@iterator(): IterableIterator<Usage>
  • Iterator

    Returns IterableIterator<Usage>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Usage>[]): Usage[]
  • concat(...items: (T | ConcatArray<T>)[]): Usage[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Usage>[]

      Additional items to add to the end of array1.

    Returns Usage[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Usage[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Usage]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Usage]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: Usage, index: number, array: Usage[]): boolean
        • Parameters

          • value: Usage
          • index: number
          • array: Usage[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Usage, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Usage

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Usage[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: Usage

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Usage, index: number, array: Usage[]): boolean
        • Parameters

          • value: Usage
          • index: number
          • array: Usage[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Usage, index: number, array: Usage[]): any
        • Parameters

          • value: Usage
          • index: number
          • array: Usage[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Usage[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Usage | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: Usage

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Usage, index: number, obj: Usage[]): boolean
        • Parameters

          • this: void
          • value: Usage
          • index: number
          • obj: Usage[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: Usage, index: number, obj: Usage[]): boolean
        • Parameters

          • value: Usage
          • index: number
          • obj: Usage[]

          Returns boolean

    • Optional thisArg: any

    Returns Usage | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: Usage, index: number, obj: Usage[]): boolean
        • Parameters

          • value: Usage
          • index: number
          • obj: Usage[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: Usage, index: number, array: Usage[]): void
        • Parameters

          • value: Usage
          • index: number
          • array: Usage[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Usage, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Usage

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Usage, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Usage

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Usage, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Usage

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: Usage, index: number, array: Usage[]): U
        • Parameters

          • value: Usage
          • index: number
          • array: Usage[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): Usage | undefined
  • Removes the last element from an array and returns it.

    Returns Usage | undefined

push

  • push(...items: Usage[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Usage[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Usage
  • reduce(callbackfn: function, initialValue: Usage): Usage
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: Usage, currentValue: Usage, currentIndex: number, array: Usage[]): Usage
        • Parameters

          • previousValue: Usage
          • currentValue: Usage
          • currentIndex: number
          • array: Usage[]

          Returns Usage

    Returns Usage

  • Parameters

    • callbackfn: function
        • (previousValue: Usage, currentValue: Usage, currentIndex: number, array: Usage[]): Usage
        • Parameters

          • previousValue: Usage
          • currentValue: Usage
          • currentIndex: number
          • array: Usage[]

          Returns Usage

    • initialValue: Usage

    Returns Usage

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Usage, currentIndex: number, array: Usage[]): U
        • Parameters

          • previousValue: U
          • currentValue: Usage
          • currentIndex: number
          • array: Usage[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Usage
  • reduceRight(callbackfn: function, initialValue: Usage): Usage
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: Usage, currentValue: Usage, currentIndex: number, array: Usage[]): Usage
        • Parameters

          • previousValue: Usage
          • currentValue: Usage
          • currentIndex: number
          • array: Usage[]

          Returns Usage

    Returns Usage

  • Parameters

    • callbackfn: function
        • (previousValue: Usage, currentValue: Usage, currentIndex: number, array: Usage[]): Usage
        • Parameters

          • previousValue: Usage
          • currentValue: Usage
          • currentIndex: number
          • array: Usage[]

          Returns Usage

    • initialValue: Usage

    Returns Usage

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Usage, currentIndex: number, array: Usage[]): U
        • Parameters

          • previousValue: U
          • currentValue: Usage
          • currentIndex: number
          • array: Usage[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): Usage[]
  • Reverses the elements in an Array.

    Returns Usage[]

shift

  • shift(): Usage | undefined
  • Removes the first element from an array and returns it.

    Returns Usage | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Usage[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Usage[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: Usage, index: number, array: Usage[]): boolean
        • Parameters

          • value: Usage
          • index: number
          • array: Usage[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Usage[]
  • splice(start: number, deleteCount: number, ...items: Usage[]): Usage[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Usage[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Usage[]

      Elements to insert into the array in place of the deleted elements.

    Returns Usage[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Usage[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Usage[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Usage>
  • Returns an iterable of values in the array

    Returns IterableIterator<Usage>

type

type: object

className

className: string = "UsagesListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Usage"

name

name: "Composite" = "Composite"

Const VerificationIPFlowParameters

VerificationIPFlowParameters: object

Parameters that define the IP flow to be verified.

direction

direction: Direction

The direction of the packet represented as a 5-tuple. Possible values include: 'Inbound', 'Outbound'

localIPAddress

localIPAddress: string

The local IP address. Acceptable values are valid IPv4 addresses.

localPort

localPort: string

The local port. Acceptable values are a single integer in the range (0-65535). Support for * for the source port, which depends on the direction.

protocol

protocol: IpFlowProtocol

Protocol to be verified on. Possible values include: 'TCP', 'UDP'

remoteIPAddress

remoteIPAddress: string

The remote IP address. Acceptable values are valid IPv4 addresses.

remotePort

remotePort: string

The remote port. Acceptable values are a single integer in the range (0-65535). Support for * for the source port, which depends on the direction.

serializedName

serializedName: string = "VerificationIPFlowParameters"

Optional targetNicResourceId

targetNicResourceId: undefined | string

The NIC ID. (If VM has multiple NICs and IP forwarding is enabled on any of them, then this parameter must be specified. Otherwise optional).

targetResourceId

targetResourceId: string

The ID of the target resource to perform next-hop on.

type

type: object

className

className: string = "VerificationIPFlowParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

direction

direction: object

required

required: true = true

serializedName

serializedName: string = "direction"

type

type: object

name

name: "String" = "String"

localIPAddress

localIPAddress: object

required

required: true = true

serializedName

serializedName: string = "localIPAddress"

type

type: object

name

name: "String" = "String"

localPort

localPort: object

required

required: true = true

serializedName

serializedName: string = "localPort"

type

type: object

name

name: "String" = "String"

protocol

protocol: object

required

required: true = true

serializedName

serializedName: string = "protocol"

type

type: object

name

name: "String" = "String"

remoteIPAddress

remoteIPAddress: object

required

required: true = true

serializedName

serializedName: string = "remoteIPAddress"

type

type: object

name

name: "String" = "String"

remotePort

remotePort: object

required

required: true = true

serializedName

serializedName: string = "remotePort"

type

type: object

name

name: "String" = "String"

targetNicResourceId

targetNicResourceId: object

serializedName

serializedName: string = "targetNicResourceId"

type

type: object

name

name: "String" = "String"

targetResourceId

targetResourceId: object

required

required: true = true

serializedName

serializedName: string = "targetResourceId"

type

type: object

name

name: "String" = "String"

Const VerificationIPFlowResult

VerificationIPFlowResult: object

Results of IP flow verification on the target resource.

Optional access

access: Access

Indicates whether the traffic is allowed or denied. Possible values include: 'Allow', 'Deny'

Optional ruleName

ruleName: undefined | string

Name of the rule. If input is not matched against any security rule, it is not displayed.

serializedName

serializedName: string = "VerificationIPFlowResult"

type

type: object

className

className: string = "VerificationIPFlowResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

access

access: object

serializedName

serializedName: string = "access"

type

type: object

name

name: "String" = "String"

ruleName

ruleName: object

serializedName

serializedName: string = "ruleName"

type

type: object

name

name: "String" = "String"

Const VirtualHub

VirtualHub: object

VirtualHub Resource.

Optional addressPrefix

addressPrefix: undefined | string

Address-prefix for this VirtualHub.

Optional etag

etag: undefined | string

Gets a unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

Optional expressRouteGateway

expressRouteGateway: SubResource

The expressRouteGateway associated with this VirtualHub.

Optional id

id: undefined | string

Resource ID.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional p2SVpnGateway

p2SVpnGateway: SubResource

The P2SVpnGateway associated with this VirtualHub.

Optional provisioningState

provisioningState: ProvisioningState

The provisioning state of the resource. Possible values include: 'Succeeded', 'Updating', 'Deleting', 'Failed'

Optional routeTable

The routeTable associated with this virtual hub.

serializedName

serializedName: string = "VirtualHub"

Optional tags

tags: undefined | object

Resource tags.

Optional virtualNetworkConnections

virtualNetworkConnections: HubVirtualNetworkConnection[]

List of all vnet connections with this VirtualHub.

Optional virtualWan

virtualWan: SubResource

The VirtualWAN to which the VirtualHub belongs.

Optional vpnGateway

vpnGateway: SubResource

The VpnGateway associated with this VirtualHub.

type

type: object

className

className: string = "VirtualHub"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

addressPrefix

addressPrefix: object

serializedName

serializedName: string = "properties.addressPrefix"

type

type: object

name

name: "String" = "String"

etag

etag: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

expressRouteGateway

expressRouteGateway: object

serializedName

serializedName: string = "properties.expressRouteGateway"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

p2SVpnGateway

p2SVpnGateway: object

serializedName

serializedName: string = "properties.p2SVpnGateway"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

routeTable

routeTable: object

serializedName

serializedName: string = "properties.routeTable"

type

type: object

className

className: string = "VirtualHubRouteTable"

name

name: "Composite" = "Composite"

virtualNetworkConnections

virtualNetworkConnections: object

serializedName

serializedName: string = "properties.virtualNetworkConnections"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HubVirtualNetworkConnection"

name

name: "Composite" = "Composite"

virtualWan

virtualWan: object

serializedName

serializedName: string = "properties.virtualWan"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

vpnGateway

vpnGateway: object

serializedName

serializedName: string = "properties.vpnGateway"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

Const VirtualHubId

VirtualHubId: object

Virtual Hub identifier.

Optional id

id: undefined | string

The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription.

serializedName

serializedName: string = "VirtualHubId"

type

type: object

className

className: string = "VirtualHubId"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

Const VirtualHubRoute

VirtualHubRoute: object

VirtualHub route.

Optional addressPrefixes

addressPrefixes: string[]

List of all addressPrefixes.

Optional nextHopIpAddress

nextHopIpAddress: undefined | string

NextHop ip address.

serializedName

serializedName: string = "VirtualHubRoute"

type

type: object

className

className: string = "VirtualHubRoute"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

addressPrefixes

addressPrefixes: object

serializedName

serializedName: string = "addressPrefixes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

nextHopIpAddress

nextHopIpAddress: object

serializedName

serializedName: string = "nextHopIpAddress"

type

type: object

name

name: "String" = "String"

Const VirtualHubRouteTable

VirtualHubRouteTable: object

VirtualHub route table.

Optional routes

routes: VirtualHubRoute[]

List of all routes.

serializedName

serializedName: string = "VirtualHubRouteTable"

type

type: object

className

className: string = "VirtualHubRouteTable"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

routes

routes: object

serializedName

serializedName: string = "routes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VirtualHubRoute"

name

name: "Composite" = "Composite"

Const VirtualNetwork

VirtualNetwork: object

Virtual Network resource.

Optional addressSpace

addressSpace: AddressSpace

The AddressSpace that contains an array of IP address ranges that can be used by subnets.

Optional ddosProtectionPlan

ddosProtectionPlan: SubResource

The DDoS protection plan associated with the virtual network.

Optional dhcpOptions

dhcpOptions: DhcpOptions

The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network.

Optional enableDdosProtection

enableDdosProtection: undefined | false | true

Indicates if DDoS protection is enabled for all the protected resources in the virtual network. It requires a DDoS protection plan associated with the resource. Default value: false.

Optional enableVmProtection

enableVmProtection: undefined | false | true

Indicates if VM protection is enabled for all the subnets in the virtual network. Default value: false.

Optional etag

etag: undefined | string

Gets a unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

Optional resourceGuid

resourceGuid: undefined | string

The resourceGuid property of the Virtual Network resource.

serializedName

serializedName: string = "VirtualNetwork"

Optional subnets

subnets: Subnet[]

A list of subnets in a Virtual Network.

Optional tags

tags: undefined | object

Resource tags.

Optional virtualNetworkPeerings

virtualNetworkPeerings: VirtualNetworkPeering[]

A list of peerings in a Virtual Network.

type

type: object

className

className: string = "VirtualNetwork"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

addressSpace

addressSpace: object

serializedName

serializedName: string = "properties.addressSpace"

type

type: object

className

className: string = "AddressSpace"

name

name: "Composite" = "Composite"

ddosProtectionPlan

ddosProtectionPlan: object

serializedName

serializedName: string = "properties.ddosProtectionPlan"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

dhcpOptions

dhcpOptions: object

serializedName

serializedName: string = "properties.dhcpOptions"

type

type: object

className

className: string = "DhcpOptions"

name

name: "Composite" = "Composite"

enableDdosProtection

enableDdosProtection: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "properties.enableDdosProtection"

type

type: object

name

name: "Boolean" = "Boolean"

enableVmProtection

enableVmProtection: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "properties.enableVmProtection"

type

type: object

name

name: "Boolean" = "Boolean"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

resourceGuid

resourceGuid: object

serializedName

serializedName: string = "properties.resourceGuid"

type

type: object

name

name: "String" = "String"

subnets

subnets: object

serializedName

serializedName: string = "properties.subnets"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Subnet"

name

name: "Composite" = "Composite"

virtualNetworkPeerings

virtualNetworkPeerings: object

serializedName

serializedName: string = "properties.virtualNetworkPeerings"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VirtualNetworkPeering"

name

name: "Composite" = "Composite"

Const VirtualNetworkConnectionGatewayReference

VirtualNetworkConnectionGatewayReference: object

A reference to VirtualNetworkGateway or LocalNetworkGateway resource.

id

id: string

The ID of VirtualNetworkGateway or LocalNetworkGateway resource.

serializedName

serializedName: string = "VirtualNetworkConnectionGatewayReference"

type

type: object

className

className: string = "VirtualNetworkConnectionGatewayReference"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

required

required: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

Const VirtualNetworkGateway

VirtualNetworkGateway: object

A common class for general resource information.

Optional activeActive

activeActive: undefined | false | true

ActiveActive flag.

Optional bgpSettings

bgpSettings: BgpSettings

Virtual network gateway's BGP speaker settings.

Optional customRoutes

customRoutes: AddressSpace

The reference of the address space resource which represents the custom routes address space specified by the the customer for virtual network gateway and VpnClient.

Optional enableBgp

enableBgp: undefined | false | true

Whether BGP is enabled for this virtual network gateway or not.

Optional etag

etag: undefined | string

Gets a unique read-only string that changes whenever the resource is updated.

Optional gatewayDefaultSite

gatewayDefaultSite: SubResource

The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting.

Optional gatewayType

The type of this virtual network gateway. Possible values include: 'Vpn', 'ExpressRoute'

Optional id

id: undefined | string

Resource ID.

Optional ipConfigurations

ipConfigurations: VirtualNetworkGatewayIPConfiguration[]

IP configurations for virtual network gateway.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceGuid

resourceGuid: undefined | string

The resource GUID property of the VirtualNetworkGateway resource.

serializedName

serializedName: string = "VirtualNetworkGateway"

Optional sku

The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.

Optional tags

tags: undefined | object

Resource tags.

Optional vpnClientConfiguration

vpnClientConfiguration: VpnClientConfiguration

The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations.

Optional vpnType

vpnType: VpnType

The type of this virtual network gateway. Possible values include: 'PolicyBased', 'RouteBased'

type

type: object

className

className: string = "VirtualNetworkGateway"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

activeActive

activeActive: object

serializedName

serializedName: string = "properties.activeActive"

type

type: object

name

name: "Boolean" = "Boolean"

bgpSettings

bgpSettings: object

serializedName

serializedName: string = "properties.bgpSettings"

type

type: object

className

className: string = "BgpSettings"

name

name: "Composite" = "Composite"

customRoutes

customRoutes: object

serializedName

serializedName: string = "properties.customRoutes"

type

type: object

className

className: string = "AddressSpace"

name

name: "Composite" = "Composite"

enableBgp

enableBgp: object

serializedName

serializedName: string = "properties.enableBgp"

type

type: object

name

name: "Boolean" = "Boolean"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

gatewayDefaultSite

gatewayDefaultSite: object

serializedName

serializedName: string = "properties.gatewayDefaultSite"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

gatewayType

gatewayType: object

serializedName

serializedName: string = "properties.gatewayType"

type

type: object

name

name: "String" = "String"

ipConfigurations

ipConfigurations: object

serializedName

serializedName: string = "properties.ipConfigurations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VirtualNetworkGatewayIPConfiguration"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

resourceGuid

resourceGuid: object

serializedName

serializedName: string = "properties.resourceGuid"

type

type: object

name

name: "String" = "String"

sku

sku: object

serializedName

serializedName: string = "properties.sku"

type

type: object

className

className: string = "VirtualNetworkGatewaySku"

name

name: "Composite" = "Composite"

vpnClientConfiguration

vpnClientConfiguration: object

serializedName

serializedName: string = "properties.vpnClientConfiguration"

type

type: object

className

className: string = "VpnClientConfiguration"

name

name: "Composite" = "Composite"

vpnType

vpnType: object

serializedName

serializedName: string = "properties.vpnType"

type

type: object

name

name: "String" = "String"

Const VirtualNetworkGatewayConnection

VirtualNetworkGatewayConnection: object

A common class for general resource information.

Optional authorizationKey

authorizationKey: undefined | string

The authorizationKey.

Optional connectionProtocol

Connection protocol used for this connection. Possible values include: 'IKEv2', 'IKEv1'

Optional connectionStatus

Virtual Network Gateway connection status. Possible values include: 'Unknown', 'Connecting', 'Connected', 'NotConnected' NOTE: This property will not be serialized. It can only be populated by the server.

connectionType

Gateway connection type. Possible values include: 'IPsec', 'Vnet2Vnet', 'ExpressRoute', 'VPNClient'

Optional egressBytesTransferred

egressBytesTransferred: undefined | number

The egress bytes transferred in this connection. NOTE: This property will not be serialized. It can only be populated by the server.

Optional enableBgp

enableBgp: undefined | false | true

EnableBgp flag.

Optional etag

etag: undefined | string

Gets a unique read-only string that changes whenever the resource is updated.

Optional expressRouteGatewayBypass

expressRouteGatewayBypass: undefined | false | true

Bypass ExpressRoute Gateway for data forwarding.

Optional id

id: undefined | string

Resource ID.

Optional ingressBytesTransferred

ingressBytesTransferred: undefined | number

The ingress bytes transferred in this connection. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ipsecPolicies

ipsecPolicies: IpsecPolicy[]

The IPSec Policies to be considered by this connection.

Optional localNetworkGateway2

localNetworkGateway2: LocalNetworkGateway

The reference to local network gateway resource.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional peer

The reference to peerings resource.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceGuid

resourceGuid: undefined | string

The resource GUID property of the VirtualNetworkGatewayConnection resource.

Optional routingWeight

routingWeight: undefined | number

The routing weight.

serializedName

serializedName: string = "VirtualNetworkGatewayConnection"

Optional sharedKey

sharedKey: undefined | string

The IPSec shared key.

Optional tags

tags: undefined | object

Resource tags.

Optional tunnelConnectionStatus

tunnelConnectionStatus: TunnelConnectionHealth[]

Collection of all tunnels' connection health status. NOTE: This property will not be serialized. It can only be populated by the server.

Optional usePolicyBasedTrafficSelectors

usePolicyBasedTrafficSelectors: undefined | false | true

Enable policy-based traffic selectors.

virtualNetworkGateway1

virtualNetworkGateway1: VirtualNetworkGateway

The reference to virtual network gateway resource.

Optional virtualNetworkGateway2

virtualNetworkGateway2: VirtualNetworkGateway

The reference to virtual network gateway resource.

type

type: object

className

className: string = "VirtualNetworkGatewayConnection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

authorizationKey

authorizationKey: object

serializedName

serializedName: string = "properties.authorizationKey"

type

type: object

name

name: "String" = "String"

connectionProtocol

connectionProtocol: object

serializedName

serializedName: string = "properties.connectionProtocol"

type

type: object

name

name: "String" = "String"

connectionStatus

connectionStatus: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.connectionStatus"

type

type: object

name

name: "String" = "String"

connectionType

connectionType: object

required

required: true = true

serializedName

serializedName: string = "properties.connectionType"

type

type: object

name

name: "String" = "String"

egressBytesTransferred

egressBytesTransferred: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.egressBytesTransferred"

type

type: object

name

name: "Number" = "Number"

enableBgp

enableBgp: object

serializedName

serializedName: string = "properties.enableBgp"

type

type: object

name

name: "Boolean" = "Boolean"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

expressRouteGatewayBypass

expressRouteGatewayBypass: object

serializedName

serializedName: string = "properties.expressRouteGatewayBypass"

type

type: object

name

name: "Boolean" = "Boolean"

ingressBytesTransferred

ingressBytesTransferred: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.ingressBytesTransferred"

type

type: object

name

name: "Number" = "Number"

ipsecPolicies

ipsecPolicies: object

serializedName

serializedName: string = "properties.ipsecPolicies"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "IpsecPolicy"

name

name: "Composite" = "Composite"

localNetworkGateway2

localNetworkGateway2: object

serializedName

serializedName: string = "properties.localNetworkGateway2"

type

type: object

className

className: string = "LocalNetworkGateway"

name

name: "Composite" = "Composite"

peer

peer: object

serializedName

serializedName: string = "properties.peer"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

resourceGuid

resourceGuid: object

serializedName

serializedName: string = "properties.resourceGuid"

type

type: object

name

name: "String" = "String"

routingWeight

routingWeight: object

serializedName

serializedName: string = "properties.routingWeight"

type

type: object

name

name: "Number" = "Number"

sharedKey

sharedKey: object

serializedName

serializedName: string = "properties.sharedKey"

type

type: object

name

name: "String" = "String"

tunnelConnectionStatus

tunnelConnectionStatus: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.tunnelConnectionStatus"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "TunnelConnectionHealth"

name

name: "Composite" = "Composite"

usePolicyBasedTrafficSelectors

usePolicyBasedTrafficSelectors: object

serializedName

serializedName: string = "properties.usePolicyBasedTrafficSelectors"

type

type: object

name

name: "Boolean" = "Boolean"

virtualNetworkGateway1

virtualNetworkGateway1: object

required

required: true = true

serializedName

serializedName: string = "properties.virtualNetworkGateway1"

type

type: object

className

className: string = "VirtualNetworkGateway"

name

name: "Composite" = "Composite"

virtualNetworkGateway2

virtualNetworkGateway2: object

serializedName

serializedName: string = "properties.virtualNetworkGateway2"

type

type: object

className

className: string = "VirtualNetworkGateway"

name

name: "Composite" = "Composite"

Const VirtualNetworkGatewayConnectionListEntity

VirtualNetworkGatewayConnectionListEntity: object

A common class for general resource information.

Optional authorizationKey

authorizationKey: undefined | string

The authorizationKey.

Optional connectionProtocol

Connection protocol used for this connection. Possible values include: 'IKEv2', 'IKEv1'

Optional connectionStatus

Virtual Network Gateway connection status. Possible values include: 'Unknown', 'Connecting', 'Connected', 'NotConnected' NOTE: This property will not be serialized. It can only be populated by the server.

connectionType

Gateway connection type. Possible values include: 'IPsec', 'Vnet2Vnet', 'ExpressRoute', 'VPNClient'

Optional egressBytesTransferred

egressBytesTransferred: undefined | number

The egress bytes transferred in this connection. NOTE: This property will not be serialized. It can only be populated by the server.

Optional enableBgp

enableBgp: undefined | false | true

EnableBgp flag.

Optional etag

etag: undefined | string

Gets a unique read-only string that changes whenever the resource is updated.

Optional expressRouteGatewayBypass

expressRouteGatewayBypass: undefined | false | true

Bypass ExpressRoute Gateway for data forwarding.

Optional id

id: undefined | string

Resource ID.

Optional ingressBytesTransferred

ingressBytesTransferred: undefined | number

The ingress bytes transferred in this connection. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ipsecPolicies

ipsecPolicies: IpsecPolicy[]

The IPSec Policies to be considered by this connection.

Optional localNetworkGateway2

The reference to local network gateway resource.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional peer

The reference to peerings resource.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceGuid

resourceGuid: undefined | string

The resource GUID property of the VirtualNetworkGatewayConnection resource.

Optional routingWeight

routingWeight: undefined | number

The routing weight.

serializedName

serializedName: string = "VirtualNetworkGatewayConnectionListEntity"

Optional sharedKey

sharedKey: undefined | string

The IPSec shared key.

Optional tags

tags: undefined | object

Resource tags.

Optional tunnelConnectionStatus

tunnelConnectionStatus: TunnelConnectionHealth[]

Collection of all tunnels' connection health status. NOTE: This property will not be serialized. It can only be populated by the server.

Optional usePolicyBasedTrafficSelectors

usePolicyBasedTrafficSelectors: undefined | false | true

Enable policy-based traffic selectors.

virtualNetworkGateway1

virtualNetworkGateway1: VirtualNetworkConnectionGatewayReference

The reference to virtual network gateway resource.

Optional virtualNetworkGateway2

The reference to virtual network gateway resource.

type

type: object

className

className: string = "VirtualNetworkGatewayConnectionListEntity"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

authorizationKey

authorizationKey: object

serializedName

serializedName: string = "properties.authorizationKey"

type

type: object

name

name: "String" = "String"

connectionProtocol

connectionProtocol: object

serializedName

serializedName: string = "properties.connectionProtocol"

type

type: object

name

name: "String" = "String"

connectionStatus

connectionStatus: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.connectionStatus"

type

type: object

name

name: "String" = "String"

connectionType

connectionType: object

required

required: true = true

serializedName

serializedName: string = "properties.connectionType"

type

type: object

name

name: "String" = "String"

egressBytesTransferred

egressBytesTransferred: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.egressBytesTransferred"

type

type: object

name

name: "Number" = "Number"

enableBgp

enableBgp: object

serializedName

serializedName: string = "properties.enableBgp"

type

type: object

name

name: "Boolean" = "Boolean"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

expressRouteGatewayBypass

expressRouteGatewayBypass: object

serializedName

serializedName: string = "properties.expressRouteGatewayBypass"

type

type: object

name

name: "Boolean" = "Boolean"

ingressBytesTransferred

ingressBytesTransferred: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.ingressBytesTransferred"

type

type: object

name

name: "Number" = "Number"

ipsecPolicies

ipsecPolicies: object

serializedName

serializedName: string = "properties.ipsecPolicies"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "IpsecPolicy"

name

name: "Composite" = "Composite"

localNetworkGateway2

localNetworkGateway2: object

serializedName

serializedName: string = "properties.localNetworkGateway2"

type

type: object

className

className: string = "VirtualNetworkConnectionGatewayReference"

name

name: "Composite" = "Composite"

peer

peer: object

serializedName

serializedName: string = "properties.peer"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

resourceGuid

resourceGuid: object

serializedName

serializedName: string = "properties.resourceGuid"

type

type: object

name

name: "String" = "String"

routingWeight

routingWeight: object

serializedName

serializedName: string = "properties.routingWeight"

type

type: object

name

name: "Number" = "Number"

sharedKey

sharedKey: object

serializedName

serializedName: string = "properties.sharedKey"

type

type: object

name

name: "String" = "String"

tunnelConnectionStatus

tunnelConnectionStatus: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.tunnelConnectionStatus"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "TunnelConnectionHealth"

name

name: "Composite" = "Composite"

usePolicyBasedTrafficSelectors

usePolicyBasedTrafficSelectors: object

serializedName

serializedName: string = "properties.usePolicyBasedTrafficSelectors"

type

type: object

name

name: "Boolean" = "Boolean"

virtualNetworkGateway1

virtualNetworkGateway1: object

required

required: true = true

serializedName

serializedName: string = "properties.virtualNetworkGateway1"

type

type: object

className

className: string = "VirtualNetworkConnectionGatewayReference"

name

name: "Composite" = "Composite"

virtualNetworkGateway2

virtualNetworkGateway2: object

serializedName

serializedName: string = "properties.virtualNetworkGateway2"

type

type: object

className

className: string = "VirtualNetworkConnectionGatewayReference"

name

name: "Composite" = "Composite"

Const VirtualNetworkGatewayConnectionListResult

VirtualNetworkGatewayConnectionListResult: object
interface

Response for the ListVirtualNetworkGatewayConnections API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "VirtualNetworkGatewayConnectionListResult"

__@iterator

  • __@iterator(): IterableIterator<VirtualNetworkGatewayConnection>
  • Iterator

    Returns IterableIterator<VirtualNetworkGatewayConnection>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<VirtualNetworkGatewayConnection>[]): VirtualNetworkGatewayConnection[]
  • concat(...items: (T | ConcatArray<T>)[]): VirtualNetworkGatewayConnection[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<VirtualNetworkGatewayConnection>[]

      Additional items to add to the end of array1.

    Returns VirtualNetworkGatewayConnection[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns VirtualNetworkGatewayConnection[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, VirtualNetworkGatewayConnection]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, VirtualNetworkGatewayConnection]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: VirtualNetworkGatewayConnection, index: number, array: VirtualNetworkGatewayConnection[]): boolean
        • Parameters

          • value: VirtualNetworkGatewayConnection
          • index: number
          • array: VirtualNetworkGatewayConnection[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: VirtualNetworkGatewayConnection, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: VirtualNetworkGatewayConnection

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): VirtualNetworkGatewayConnection[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: VirtualNetworkGatewayConnection

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkGatewayConnection, index: number, array: VirtualNetworkGatewayConnection[]): boolean
        • Parameters

          • value: VirtualNetworkGatewayConnection
          • index: number
          • array: VirtualNetworkGatewayConnection[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkGatewayConnection, index: number, array: VirtualNetworkGatewayConnection[]): any
        • Parameters

          • value: VirtualNetworkGatewayConnection
          • index: number
          • array: VirtualNetworkGatewayConnection[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns VirtualNetworkGatewayConnection[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): VirtualNetworkGatewayConnection | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: VirtualNetworkGatewayConnection

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: VirtualNetworkGatewayConnection, index: number, obj: VirtualNetworkGatewayConnection[]): boolean
        • Parameters

          • this: void
          • value: VirtualNetworkGatewayConnection
          • index: number
          • obj: VirtualNetworkGatewayConnection[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: VirtualNetworkGatewayConnection, index: number, obj: VirtualNetworkGatewayConnection[]): boolean
        • Parameters

          • value: VirtualNetworkGatewayConnection
          • index: number
          • obj: VirtualNetworkGatewayConnection[]

          Returns boolean

    • Optional thisArg: any

    Returns VirtualNetworkGatewayConnection | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: VirtualNetworkGatewayConnection, index: number, obj: VirtualNetworkGatewayConnection[]): boolean
        • Parameters

          • value: VirtualNetworkGatewayConnection
          • index: number
          • obj: VirtualNetworkGatewayConnection[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkGatewayConnection, index: number, array: VirtualNetworkGatewayConnection[]): void
        • Parameters

          • value: VirtualNetworkGatewayConnection
          • index: number
          • array: VirtualNetworkGatewayConnection[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: VirtualNetworkGatewayConnection, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: VirtualNetworkGatewayConnection

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: VirtualNetworkGatewayConnection, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: VirtualNetworkGatewayConnection

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: VirtualNetworkGatewayConnection, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: VirtualNetworkGatewayConnection

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkGatewayConnection, index: number, array: VirtualNetworkGatewayConnection[]): U
        • Parameters

          • value: VirtualNetworkGatewayConnection
          • index: number
          • array: VirtualNetworkGatewayConnection[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): VirtualNetworkGatewayConnection | undefined
  • Removes the last element from an array and returns it.

    Returns VirtualNetworkGatewayConnection | undefined

push

  • push(...items: VirtualNetworkGatewayConnection[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: VirtualNetworkGatewayConnection[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): VirtualNetworkGatewayConnection
  • reduce(callbackfn: function, initialValue: VirtualNetworkGatewayConnection): VirtualNetworkGatewayConnection
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: VirtualNetworkGatewayConnection, currentValue: VirtualNetworkGatewayConnection, currentIndex: number, array: VirtualNetworkGatewayConnection[]): VirtualNetworkGatewayConnection
        • Parameters

          • previousValue: VirtualNetworkGatewayConnection
          • currentValue: VirtualNetworkGatewayConnection
          • currentIndex: number
          • array: VirtualNetworkGatewayConnection[]

          Returns VirtualNetworkGatewayConnection

    Returns VirtualNetworkGatewayConnection

  • Parameters

    • callbackfn: function
        • (previousValue: VirtualNetworkGatewayConnection, currentValue: VirtualNetworkGatewayConnection, currentIndex: number, array: VirtualNetworkGatewayConnection[]): VirtualNetworkGatewayConnection
        • Parameters

          • previousValue: VirtualNetworkGatewayConnection
          • currentValue: VirtualNetworkGatewayConnection
          • currentIndex: number
          • array: VirtualNetworkGatewayConnection[]

          Returns VirtualNetworkGatewayConnection

    • initialValue: VirtualNetworkGatewayConnection

    Returns VirtualNetworkGatewayConnection

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: VirtualNetworkGatewayConnection, currentIndex: number, array: VirtualNetworkGatewayConnection[]): U
        • Parameters

          • previousValue: U
          • currentValue: VirtualNetworkGatewayConnection
          • currentIndex: number
          • array: VirtualNetworkGatewayConnection[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): VirtualNetworkGatewayConnection
  • reduceRight(callbackfn: function, initialValue: VirtualNetworkGatewayConnection): VirtualNetworkGatewayConnection
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: VirtualNetworkGatewayConnection, currentValue: VirtualNetworkGatewayConnection, currentIndex: number, array: VirtualNetworkGatewayConnection[]): VirtualNetworkGatewayConnection
        • Parameters

          • previousValue: VirtualNetworkGatewayConnection
          • currentValue: VirtualNetworkGatewayConnection
          • currentIndex: number
          • array: VirtualNetworkGatewayConnection[]

          Returns VirtualNetworkGatewayConnection

    Returns VirtualNetworkGatewayConnection

  • Parameters

    • callbackfn: function
        • (previousValue: VirtualNetworkGatewayConnection, currentValue: VirtualNetworkGatewayConnection, currentIndex: number, array: VirtualNetworkGatewayConnection[]): VirtualNetworkGatewayConnection
        • Parameters

          • previousValue: VirtualNetworkGatewayConnection
          • currentValue: VirtualNetworkGatewayConnection
          • currentIndex: number
          • array: VirtualNetworkGatewayConnection[]

          Returns VirtualNetworkGatewayConnection

    • initialValue: VirtualNetworkGatewayConnection

    Returns VirtualNetworkGatewayConnection

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: VirtualNetworkGatewayConnection, currentIndex: number, array: VirtualNetworkGatewayConnection[]): U
        • Parameters

          • previousValue: U
          • currentValue: VirtualNetworkGatewayConnection
          • currentIndex: number
          • array: VirtualNetworkGatewayConnection[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): VirtualNetworkGatewayConnection[]
  • Reverses the elements in an Array.

    Returns VirtualNetworkGatewayConnection[]

shift

  • shift(): VirtualNetworkGatewayConnection | undefined
  • Removes the first element from an array and returns it.

    Returns VirtualNetworkGatewayConnection | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): VirtualNetworkGatewayConnection[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns VirtualNetworkGatewayConnection[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: VirtualNetworkGatewayConnection, index: number, array: VirtualNetworkGatewayConnection[]): boolean
        • Parameters

          • value: VirtualNetworkGatewayConnection
          • index: number
          • array: VirtualNetworkGatewayConnection[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): VirtualNetworkGatewayConnection[]
  • splice(start: number, deleteCount: number, ...items: VirtualNetworkGatewayConnection[]): VirtualNetworkGatewayConnection[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns VirtualNetworkGatewayConnection[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: VirtualNetworkGatewayConnection[]

      Elements to insert into the array in place of the deleted elements.

    Returns VirtualNetworkGatewayConnection[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: VirtualNetworkGatewayConnection[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: VirtualNetworkGatewayConnection[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<VirtualNetworkGatewayConnection>
  • Returns an iterable of values in the array

    Returns IterableIterator<VirtualNetworkGatewayConnection>

type

type: object

className

className: string = "VirtualNetworkGatewayConnectionListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VirtualNetworkGatewayConnection"

name

name: "Composite" = "Composite"

Const VirtualNetworkGatewayIPConfiguration

VirtualNetworkGatewayIPConfiguration: object

IP configuration for virtual network gateway.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional privateIPAllocationMethod

privateIPAllocationMethod: IPAllocationMethod

The private IP address allocation method. Possible values include: 'Static', 'Dynamic'

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. NOTE: This property will not be serialized. It can only be populated by the server.

Optional publicIPAddress

publicIPAddress: SubResource

The reference of the public IP resource.

serializedName

serializedName: string = "VirtualNetworkGatewayIPConfiguration"

Optional subnet

subnet: SubResource

The reference of the subnet resource.

type

type: object

className

className: string = "VirtualNetworkGatewayIPConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

privateIPAllocationMethod

privateIPAllocationMethod: object

serializedName

serializedName: string = "properties.privateIPAllocationMethod"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

publicIPAddress

publicIPAddress: object

serializedName

serializedName: string = "properties.publicIPAddress"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

subnet

subnet: object

serializedName

serializedName: string = "properties.subnet"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

Const VirtualNetworkGatewayListConnectionsResult

VirtualNetworkGatewayListConnectionsResult: object
interface

Response for the VirtualNetworkGatewayListConnections API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "VirtualNetworkGatewayListConnectionsResult"

__@iterator

  • __@iterator(): IterableIterator<VirtualNetworkGatewayConnectionListEntity>
  • Iterator

    Returns IterableIterator<VirtualNetworkGatewayConnectionListEntity>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<VirtualNetworkGatewayConnectionListEntity>[]): VirtualNetworkGatewayConnectionListEntity[]
  • concat(...items: (T | ConcatArray<T>)[]): VirtualNetworkGatewayConnectionListEntity[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<VirtualNetworkGatewayConnectionListEntity>[]

      Additional items to add to the end of array1.

    Returns VirtualNetworkGatewayConnectionListEntity[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns VirtualNetworkGatewayConnectionListEntity[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, VirtualNetworkGatewayConnectionListEntity]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, VirtualNetworkGatewayConnectionListEntity]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: VirtualNetworkGatewayConnectionListEntity, index: number, array: VirtualNetworkGatewayConnectionListEntity[]): boolean
        • Parameters

          • value: VirtualNetworkGatewayConnectionListEntity
          • index: number
          • array: VirtualNetworkGatewayConnectionListEntity[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: VirtualNetworkGatewayConnectionListEntity, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: VirtualNetworkGatewayConnectionListEntity

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): VirtualNetworkGatewayConnectionListEntity[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: VirtualNetworkGatewayConnectionListEntity

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkGatewayConnectionListEntity, index: number, array: VirtualNetworkGatewayConnectionListEntity[]): boolean
        • Parameters

          • value: VirtualNetworkGatewayConnectionListEntity
          • index: number
          • array: VirtualNetworkGatewayConnectionListEntity[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkGatewayConnectionListEntity, index: number, array: VirtualNetworkGatewayConnectionListEntity[]): any
        • Parameters

          • value: VirtualNetworkGatewayConnectionListEntity
          • index: number
          • array: VirtualNetworkGatewayConnectionListEntity[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns VirtualNetworkGatewayConnectionListEntity[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): VirtualNetworkGatewayConnectionListEntity | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: VirtualNetworkGatewayConnectionListEntity

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: VirtualNetworkGatewayConnectionListEntity, index: number, obj: VirtualNetworkGatewayConnectionListEntity[]): boolean
        • Parameters

          • this: void
          • value: VirtualNetworkGatewayConnectionListEntity
          • index: number
          • obj: VirtualNetworkGatewayConnectionListEntity[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: VirtualNetworkGatewayConnectionListEntity, index: number, obj: VirtualNetworkGatewayConnectionListEntity[]): boolean
        • Parameters

          • value: VirtualNetworkGatewayConnectionListEntity
          • index: number
          • obj: VirtualNetworkGatewayConnectionListEntity[]

          Returns boolean

    • Optional thisArg: any

    Returns VirtualNetworkGatewayConnectionListEntity | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: VirtualNetworkGatewayConnectionListEntity, index: number, obj: VirtualNetworkGatewayConnectionListEntity[]): boolean
        • Parameters

          • value: VirtualNetworkGatewayConnectionListEntity
          • index: number
          • obj: VirtualNetworkGatewayConnectionListEntity[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkGatewayConnectionListEntity, index: number, array: VirtualNetworkGatewayConnectionListEntity[]): void
        • Parameters

          • value: VirtualNetworkGatewayConnectionListEntity
          • index: number
          • array: VirtualNetworkGatewayConnectionListEntity[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: VirtualNetworkGatewayConnectionListEntity, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: VirtualNetworkGatewayConnectionListEntity

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: VirtualNetworkGatewayConnectionListEntity, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: VirtualNetworkGatewayConnectionListEntity

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: VirtualNetworkGatewayConnectionListEntity, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: VirtualNetworkGatewayConnectionListEntity

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkGatewayConnectionListEntity, index: number, array: VirtualNetworkGatewayConnectionListEntity[]): U
        • Parameters

          • value: VirtualNetworkGatewayConnectionListEntity
          • index: number
          • array: VirtualNetworkGatewayConnectionListEntity[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): VirtualNetworkGatewayConnectionListEntity | undefined
  • Removes the last element from an array and returns it.

    Returns VirtualNetworkGatewayConnectionListEntity | undefined

push

  • push(...items: VirtualNetworkGatewayConnectionListEntity[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: VirtualNetworkGatewayConnectionListEntity[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): VirtualNetworkGatewayConnectionListEntity
  • reduce(callbackfn: function, initialValue: VirtualNetworkGatewayConnectionListEntity): VirtualNetworkGatewayConnectionListEntity
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: VirtualNetworkGatewayConnectionListEntity, currentValue: VirtualNetworkGatewayConnectionListEntity, currentIndex: number, array: VirtualNetworkGatewayConnectionListEntity[]): VirtualNetworkGatewayConnectionListEntity
        • Parameters

          • previousValue: VirtualNetworkGatewayConnectionListEntity
          • currentValue: VirtualNetworkGatewayConnectionListEntity
          • currentIndex: number
          • array: VirtualNetworkGatewayConnectionListEntity[]

          Returns VirtualNetworkGatewayConnectionListEntity

    Returns VirtualNetworkGatewayConnectionListEntity

  • Parameters

    • callbackfn: function
        • (previousValue: VirtualNetworkGatewayConnectionListEntity, currentValue: VirtualNetworkGatewayConnectionListEntity, currentIndex: number, array: VirtualNetworkGatewayConnectionListEntity[]): VirtualNetworkGatewayConnectionListEntity
        • Parameters

          • previousValue: VirtualNetworkGatewayConnectionListEntity
          • currentValue: VirtualNetworkGatewayConnectionListEntity
          • currentIndex: number
          • array: VirtualNetworkGatewayConnectionListEntity[]

          Returns VirtualNetworkGatewayConnectionListEntity

    • initialValue: VirtualNetworkGatewayConnectionListEntity

    Returns VirtualNetworkGatewayConnectionListEntity

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: VirtualNetworkGatewayConnectionListEntity, currentIndex: number, array: VirtualNetworkGatewayConnectionListEntity[]): U
        • Parameters

          • previousValue: U
          • currentValue: VirtualNetworkGatewayConnectionListEntity
          • currentIndex: number
          • array: VirtualNetworkGatewayConnectionListEntity[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): VirtualNetworkGatewayConnectionListEntity
  • reduceRight(callbackfn: function, initialValue: VirtualNetworkGatewayConnectionListEntity): VirtualNetworkGatewayConnectionListEntity
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: VirtualNetworkGatewayConnectionListEntity, currentValue: VirtualNetworkGatewayConnectionListEntity, currentIndex: number, array: VirtualNetworkGatewayConnectionListEntity[]): VirtualNetworkGatewayConnectionListEntity
        • Parameters

          • previousValue: VirtualNetworkGatewayConnectionListEntity
          • currentValue: VirtualNetworkGatewayConnectionListEntity
          • currentIndex: number
          • array: VirtualNetworkGatewayConnectionListEntity[]

          Returns VirtualNetworkGatewayConnectionListEntity

    Returns VirtualNetworkGatewayConnectionListEntity

  • Parameters

    • callbackfn: function
        • (previousValue: VirtualNetworkGatewayConnectionListEntity, currentValue: VirtualNetworkGatewayConnectionListEntity, currentIndex: number, array: VirtualNetworkGatewayConnectionListEntity[]): VirtualNetworkGatewayConnectionListEntity
        • Parameters

          • previousValue: VirtualNetworkGatewayConnectionListEntity
          • currentValue: VirtualNetworkGatewayConnectionListEntity
          • currentIndex: number
          • array: VirtualNetworkGatewayConnectionListEntity[]

          Returns VirtualNetworkGatewayConnectionListEntity

    • initialValue: VirtualNetworkGatewayConnectionListEntity

    Returns VirtualNetworkGatewayConnectionListEntity

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: VirtualNetworkGatewayConnectionListEntity, currentIndex: number, array: VirtualNetworkGatewayConnectionListEntity[]): U
        • Parameters

          • previousValue: U
          • currentValue: VirtualNetworkGatewayConnectionListEntity
          • currentIndex: number
          • array: VirtualNetworkGatewayConnectionListEntity[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): VirtualNetworkGatewayConnectionListEntity[]
  • Reverses the elements in an Array.

    Returns VirtualNetworkGatewayConnectionListEntity[]

shift

  • shift(): VirtualNetworkGatewayConnectionListEntity | undefined
  • Removes the first element from an array and returns it.

    Returns VirtualNetworkGatewayConnectionListEntity | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): VirtualNetworkGatewayConnectionListEntity[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns VirtualNetworkGatewayConnectionListEntity[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: VirtualNetworkGatewayConnectionListEntity, index: number, array: VirtualNetworkGatewayConnectionListEntity[]): boolean
        • Parameters

          • value: VirtualNetworkGatewayConnectionListEntity
          • index: number
          • array: VirtualNetworkGatewayConnectionListEntity[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): VirtualNetworkGatewayConnectionListEntity[]
  • splice(start: number, deleteCount: number, ...items: VirtualNetworkGatewayConnectionListEntity[]): VirtualNetworkGatewayConnectionListEntity[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns VirtualNetworkGatewayConnectionListEntity[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: VirtualNetworkGatewayConnectionListEntity[]

      Elements to insert into the array in place of the deleted elements.

    Returns VirtualNetworkGatewayConnectionListEntity[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: VirtualNetworkGatewayConnectionListEntity[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: VirtualNetworkGatewayConnectionListEntity[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<VirtualNetworkGatewayConnectionListEntity>
  • Returns an iterable of values in the array

    Returns IterableIterator<VirtualNetworkGatewayConnectionListEntity>

type

type: object

className

className: string = "VirtualNetworkGatewayListConnectionsResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VirtualNetworkGatewayConnectionListEntity"

name

name: "Composite" = "Composite"

Const VirtualNetworkGatewayListResult

VirtualNetworkGatewayListResult: object
interface

Response for the ListVirtualNetworkGateways API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "VirtualNetworkGatewayListResult"

__@iterator

  • __@iterator(): IterableIterator<VirtualNetworkGateway>
  • Iterator

    Returns IterableIterator<VirtualNetworkGateway>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<VirtualNetworkGateway>[]): VirtualNetworkGateway[]
  • concat(...items: (T | ConcatArray<T>)[]): VirtualNetworkGateway[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<VirtualNetworkGateway>[]

      Additional items to add to the end of array1.

    Returns VirtualNetworkGateway[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns VirtualNetworkGateway[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, VirtualNetworkGateway]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, VirtualNetworkGateway]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: VirtualNetworkGateway, index: number, array: VirtualNetworkGateway[]): boolean
        • Parameters

          • value: VirtualNetworkGateway
          • index: number
          • array: VirtualNetworkGateway[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: VirtualNetworkGateway, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: VirtualNetworkGateway

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): VirtualNetworkGateway[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: VirtualNetworkGateway

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkGateway, index: number, array: VirtualNetworkGateway[]): boolean
        • Parameters

          • value: VirtualNetworkGateway
          • index: number
          • array: VirtualNetworkGateway[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkGateway, index: number, array: VirtualNetworkGateway[]): any
        • Parameters

          • value: VirtualNetworkGateway
          • index: number
          • array: VirtualNetworkGateway[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns VirtualNetworkGateway[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): VirtualNetworkGateway | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: VirtualNetworkGateway

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: VirtualNetworkGateway, index: number, obj: VirtualNetworkGateway[]): boolean
        • Parameters

          • this: void
          • value: VirtualNetworkGateway
          • index: number
          • obj: VirtualNetworkGateway[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: VirtualNetworkGateway, index: number, obj: VirtualNetworkGateway[]): boolean
        • Parameters

          • value: VirtualNetworkGateway
          • index: number
          • obj: VirtualNetworkGateway[]

          Returns boolean

    • Optional thisArg: any

    Returns VirtualNetworkGateway | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: VirtualNetworkGateway, index: number, obj: VirtualNetworkGateway[]): boolean
        • Parameters

          • value: VirtualNetworkGateway
          • index: number
          • obj: VirtualNetworkGateway[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkGateway, index: number, array: VirtualNetworkGateway[]): void
        • Parameters

          • value: VirtualNetworkGateway
          • index: number
          • array: VirtualNetworkGateway[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: VirtualNetworkGateway, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: VirtualNetworkGateway

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: VirtualNetworkGateway, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: VirtualNetworkGateway

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: VirtualNetworkGateway, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: VirtualNetworkGateway

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkGateway, index: number, array: VirtualNetworkGateway[]): U
        • Parameters

          • value: VirtualNetworkGateway
          • index: number
          • array: VirtualNetworkGateway[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): VirtualNetworkGateway | undefined
  • Removes the last element from an array and returns it.

    Returns VirtualNetworkGateway | undefined

push

  • push(...items: VirtualNetworkGateway[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: VirtualNetworkGateway[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): VirtualNetworkGateway
  • reduce(callbackfn: function, initialValue: VirtualNetworkGateway): VirtualNetworkGateway
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: VirtualNetworkGateway, currentValue: VirtualNetworkGateway, currentIndex: number, array: VirtualNetworkGateway[]): VirtualNetworkGateway
        • Parameters

          • previousValue: VirtualNetworkGateway
          • currentValue: VirtualNetworkGateway
          • currentIndex: number
          • array: VirtualNetworkGateway[]

          Returns VirtualNetworkGateway

    Returns VirtualNetworkGateway

  • Parameters

    • callbackfn: function
        • (previousValue: VirtualNetworkGateway, currentValue: VirtualNetworkGateway, currentIndex: number, array: VirtualNetworkGateway[]): VirtualNetworkGateway
        • Parameters

          • previousValue: VirtualNetworkGateway
          • currentValue: VirtualNetworkGateway
          • currentIndex: number
          • array: VirtualNetworkGateway[]

          Returns VirtualNetworkGateway

    • initialValue: VirtualNetworkGateway

    Returns VirtualNetworkGateway

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: VirtualNetworkGateway, currentIndex: number, array: VirtualNetworkGateway[]): U
        • Parameters

          • previousValue: U
          • currentValue: VirtualNetworkGateway
          • currentIndex: number
          • array: VirtualNetworkGateway[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): VirtualNetworkGateway
  • reduceRight(callbackfn: function, initialValue: VirtualNetworkGateway): VirtualNetworkGateway
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: VirtualNetworkGateway, currentValue: VirtualNetworkGateway, currentIndex: number, array: VirtualNetworkGateway[]): VirtualNetworkGateway
        • Parameters

          • previousValue: VirtualNetworkGateway
          • currentValue: VirtualNetworkGateway
          • currentIndex: number
          • array: VirtualNetworkGateway[]

          Returns VirtualNetworkGateway

    Returns VirtualNetworkGateway

  • Parameters

    • callbackfn: function
        • (previousValue: VirtualNetworkGateway, currentValue: VirtualNetworkGateway, currentIndex: number, array: VirtualNetworkGateway[]): VirtualNetworkGateway
        • Parameters

          • previousValue: VirtualNetworkGateway
          • currentValue: VirtualNetworkGateway
          • currentIndex: number
          • array: VirtualNetworkGateway[]

          Returns VirtualNetworkGateway

    • initialValue: VirtualNetworkGateway

    Returns VirtualNetworkGateway

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: VirtualNetworkGateway, currentIndex: number, array: VirtualNetworkGateway[]): U
        • Parameters

          • previousValue: U
          • currentValue: VirtualNetworkGateway
          • currentIndex: number
          • array: VirtualNetworkGateway[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): VirtualNetworkGateway[]
  • Reverses the elements in an Array.

    Returns VirtualNetworkGateway[]

shift

  • shift(): VirtualNetworkGateway | undefined
  • Removes the first element from an array and returns it.

    Returns VirtualNetworkGateway | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): VirtualNetworkGateway[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns VirtualNetworkGateway[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: VirtualNetworkGateway, index: number, array: VirtualNetworkGateway[]): boolean
        • Parameters

          • value: VirtualNetworkGateway
          • index: number
          • array: VirtualNetworkGateway[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): VirtualNetworkGateway[]
  • splice(start: number, deleteCount: number, ...items: VirtualNetworkGateway[]): VirtualNetworkGateway[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns VirtualNetworkGateway[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: VirtualNetworkGateway[]

      Elements to insert into the array in place of the deleted elements.

    Returns VirtualNetworkGateway[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: VirtualNetworkGateway[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: VirtualNetworkGateway[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<VirtualNetworkGateway>
  • Returns an iterable of values in the array

    Returns IterableIterator<VirtualNetworkGateway>

type

type: object

className

className: string = "VirtualNetworkGatewayListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VirtualNetworkGateway"

name

name: "Composite" = "Composite"

Const VirtualNetworkGatewaySku

VirtualNetworkGatewaySku: object

VirtualNetworkGatewaySku details.

Optional capacity

capacity: undefined | number

The capacity.

Optional name

Gateway SKU name. Possible values include: 'Basic', 'HighPerformance', 'Standard', 'UltraPerformance', 'VpnGw1', 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', 'VpnGw3AZ', 'ErGw1AZ', 'ErGw2AZ', 'ErGw3AZ'

serializedName

serializedName: string = "VirtualNetworkGatewaySku"

Optional tier

Gateway SKU tier. Possible values include: 'Basic', 'HighPerformance', 'Standard', 'UltraPerformance', 'VpnGw1', 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', 'VpnGw3AZ', 'ErGw1AZ', 'ErGw2AZ', 'ErGw3AZ'

type

type: object

className

className: string = "VirtualNetworkGatewaySku"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

capacity

capacity: object

serializedName

serializedName: string = "capacity"

type

type: object

name

name: "Number" = "Number"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

tier

tier: object

serializedName

serializedName: string = "tier"

type

type: object

name

name: "String" = "String"

Const VirtualNetworkListResult

VirtualNetworkListResult: object
interface

Response for the ListVirtualNetworks API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "VirtualNetworkListResult"

__@iterator

  • __@iterator(): IterableIterator<VirtualNetwork>
  • Iterator

    Returns IterableIterator<VirtualNetwork>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<VirtualNetwork>[]): VirtualNetwork[]
  • concat(...items: (T | ConcatArray<T>)[]): VirtualNetwork[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<VirtualNetwork>[]

      Additional items to add to the end of array1.

    Returns VirtualNetwork[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns VirtualNetwork[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, VirtualNetwork]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, VirtualNetwork]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: VirtualNetwork, index: number, array: VirtualNetwork[]): boolean
        • Parameters

          • value: VirtualNetwork
          • index: number
          • array: VirtualNetwork[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: VirtualNetwork, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: VirtualNetwork

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): VirtualNetwork[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: VirtualNetwork

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetwork, index: number, array: VirtualNetwork[]): boolean
        • Parameters

          • value: VirtualNetwork
          • index: number
          • array: VirtualNetwork[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetwork, index: number, array: VirtualNetwork[]): any
        • Parameters

          • value: VirtualNetwork
          • index: number
          • array: VirtualNetwork[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns VirtualNetwork[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): VirtualNetwork | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: VirtualNetwork

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: VirtualNetwork, index: number, obj: VirtualNetwork[]): boolean
        • Parameters

          • this: void
          • value: VirtualNetwork
          • index: number
          • obj: VirtualNetwork[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: VirtualNetwork, index: number, obj: VirtualNetwork[]): boolean
        • Parameters

          • value: VirtualNetwork
          • index: number
          • obj: VirtualNetwork[]

          Returns boolean

    • Optional thisArg: any

    Returns VirtualNetwork | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: VirtualNetwork, index: number, obj: VirtualNetwork[]): boolean
        • Parameters

          • value: VirtualNetwork
          • index: number
          • obj: VirtualNetwork[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetwork, index: number, array: VirtualNetwork[]): void
        • Parameters

          • value: VirtualNetwork
          • index: number
          • array: VirtualNetwork[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: VirtualNetwork, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: VirtualNetwork

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: VirtualNetwork, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: VirtualNetwork

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: VirtualNetwork, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: VirtualNetwork

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetwork, index: number, array: VirtualNetwork[]): U
        • Parameters

          • value: VirtualNetwork
          • index: number
          • array: VirtualNetwork[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): VirtualNetwork | undefined
  • Removes the last element from an array and returns it.

    Returns VirtualNetwork | undefined

push

  • push(...items: VirtualNetwork[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: VirtualNetwork[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): VirtualNetwork
  • reduce(callbackfn: function, initialValue: VirtualNetwork): VirtualNetwork
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: VirtualNetwork, currentValue: VirtualNetwork, currentIndex: number, array: VirtualNetwork[]): VirtualNetwork
        • Parameters

          • previousValue: VirtualNetwork
          • currentValue: VirtualNetwork
          • currentIndex: number
          • array: VirtualNetwork[]

          Returns VirtualNetwork

    Returns VirtualNetwork

  • Parameters

    • callbackfn: function
        • (previousValue: VirtualNetwork, currentValue: VirtualNetwork, currentIndex: number, array: VirtualNetwork[]): VirtualNetwork
        • Parameters

          • previousValue: VirtualNetwork
          • currentValue: VirtualNetwork
          • currentIndex: number
          • array: VirtualNetwork[]

          Returns VirtualNetwork

    • initialValue: VirtualNetwork

    Returns VirtualNetwork

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: VirtualNetwork, currentIndex: number, array: VirtualNetwork[]): U
        • Parameters

          • previousValue: U
          • currentValue: VirtualNetwork
          • currentIndex: number
          • array: VirtualNetwork[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): VirtualNetwork
  • reduceRight(callbackfn: function, initialValue: VirtualNetwork): VirtualNetwork
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: VirtualNetwork, currentValue: VirtualNetwork, currentIndex: number, array: VirtualNetwork[]): VirtualNetwork
        • Parameters

          • previousValue: VirtualNetwork
          • currentValue: VirtualNetwork
          • currentIndex: number
          • array: VirtualNetwork[]

          Returns VirtualNetwork

    Returns VirtualNetwork

  • Parameters

    • callbackfn: function
        • (previousValue: VirtualNetwork, currentValue: VirtualNetwork, currentIndex: number, array: VirtualNetwork[]): VirtualNetwork
        • Parameters

          • previousValue: VirtualNetwork
          • currentValue: VirtualNetwork
          • currentIndex: number
          • array: VirtualNetwork[]

          Returns VirtualNetwork

    • initialValue: VirtualNetwork

    Returns VirtualNetwork

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: VirtualNetwork, currentIndex: number, array: VirtualNetwork[]): U
        • Parameters

          • previousValue: U
          • currentValue: VirtualNetwork
          • currentIndex: number
          • array: VirtualNetwork[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): VirtualNetwork[]
  • Reverses the elements in an Array.

    Returns VirtualNetwork[]

shift

  • shift(): VirtualNetwork | undefined
  • Removes the first element from an array and returns it.

    Returns VirtualNetwork | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): VirtualNetwork[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns VirtualNetwork[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: VirtualNetwork, index: number, array: VirtualNetwork[]): boolean
        • Parameters

          • value: VirtualNetwork
          • index: number
          • array: VirtualNetwork[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): VirtualNetwork[]
  • splice(start: number, deleteCount: number, ...items: VirtualNetwork[]): VirtualNetwork[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns VirtualNetwork[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: VirtualNetwork[]

      Elements to insert into the array in place of the deleted elements.

    Returns VirtualNetwork[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: VirtualNetwork[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: VirtualNetwork[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<VirtualNetwork>
  • Returns an iterable of values in the array

    Returns IterableIterator<VirtualNetwork>

type

type: object

className

className: string = "VirtualNetworkListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VirtualNetwork"

name

name: "Composite" = "Composite"

Const VirtualNetworkListUsageResult

VirtualNetworkListUsageResult: object
interface

Response for the virtual networks GetUsage API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "VirtualNetworkListUsageResult"

__@iterator

  • __@iterator(): IterableIterator<VirtualNetworkUsage>
  • Iterator

    Returns IterableIterator<VirtualNetworkUsage>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<VirtualNetworkUsage>[]): VirtualNetworkUsage[]
  • concat(...items: (T | ConcatArray<T>)[]): VirtualNetworkUsage[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<VirtualNetworkUsage>[]

      Additional items to add to the end of array1.

    Returns VirtualNetworkUsage[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns VirtualNetworkUsage[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, VirtualNetworkUsage]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, VirtualNetworkUsage]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: VirtualNetworkUsage, index: number, array: VirtualNetworkUsage[]): boolean
        • Parameters

          • value: VirtualNetworkUsage
          • index: number
          • array: VirtualNetworkUsage[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: VirtualNetworkUsage, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: VirtualNetworkUsage

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): VirtualNetworkUsage[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: VirtualNetworkUsage

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkUsage, index: number, array: VirtualNetworkUsage[]): boolean
        • Parameters

          • value: VirtualNetworkUsage
          • index: number
          • array: VirtualNetworkUsage[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkUsage, index: number, array: VirtualNetworkUsage[]): any
        • Parameters

          • value: VirtualNetworkUsage
          • index: number
          • array: VirtualNetworkUsage[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns VirtualNetworkUsage[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): VirtualNetworkUsage | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: VirtualNetworkUsage

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: VirtualNetworkUsage, index: number, obj: VirtualNetworkUsage[]): boolean
        • Parameters

          • this: void
          • value: VirtualNetworkUsage
          • index: number
          • obj: VirtualNetworkUsage[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: VirtualNetworkUsage, index: number, obj: VirtualNetworkUsage[]): boolean
        • Parameters

          • value: VirtualNetworkUsage
          • index: number
          • obj: VirtualNetworkUsage[]

          Returns boolean

    • Optional thisArg: any

    Returns VirtualNetworkUsage | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: VirtualNetworkUsage, index: number, obj: VirtualNetworkUsage[]): boolean
        • Parameters

          • value: VirtualNetworkUsage
          • index: number
          • obj: VirtualNetworkUsage[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkUsage, index: number, array: VirtualNetworkUsage[]): void
        • Parameters

          • value: VirtualNetworkUsage
          • index: number
          • array: VirtualNetworkUsage[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: VirtualNetworkUsage, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: VirtualNetworkUsage

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: VirtualNetworkUsage, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: VirtualNetworkUsage

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: VirtualNetworkUsage, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: VirtualNetworkUsage

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkUsage, index: number, array: VirtualNetworkUsage[]): U
        • Parameters

          • value: VirtualNetworkUsage
          • index: number
          • array: VirtualNetworkUsage[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): VirtualNetworkUsage | undefined
  • Removes the last element from an array and returns it.

    Returns VirtualNetworkUsage | undefined

push

  • push(...items: VirtualNetworkUsage[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: VirtualNetworkUsage[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): VirtualNetworkUsage
  • reduce(callbackfn: function, initialValue: VirtualNetworkUsage): VirtualNetworkUsage
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: VirtualNetworkUsage, currentValue: VirtualNetworkUsage, currentIndex: number, array: VirtualNetworkUsage[]): VirtualNetworkUsage
        • Parameters

          • previousValue: VirtualNetworkUsage
          • currentValue: VirtualNetworkUsage
          • currentIndex: number
          • array: VirtualNetworkUsage[]

          Returns VirtualNetworkUsage

    Returns VirtualNetworkUsage

  • Parameters

    • callbackfn: function
        • (previousValue: VirtualNetworkUsage, currentValue: VirtualNetworkUsage, currentIndex: number, array: VirtualNetworkUsage[]): VirtualNetworkUsage
        • Parameters

          • previousValue: VirtualNetworkUsage
          • currentValue: VirtualNetworkUsage
          • currentIndex: number
          • array: VirtualNetworkUsage[]

          Returns VirtualNetworkUsage

    • initialValue: VirtualNetworkUsage

    Returns VirtualNetworkUsage

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: VirtualNetworkUsage, currentIndex: number, array: VirtualNetworkUsage[]): U
        • Parameters

          • previousValue: U
          • currentValue: VirtualNetworkUsage
          • currentIndex: number
          • array: VirtualNetworkUsage[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): VirtualNetworkUsage
  • reduceRight(callbackfn: function, initialValue: VirtualNetworkUsage): VirtualNetworkUsage
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: VirtualNetworkUsage, currentValue: VirtualNetworkUsage, currentIndex: number, array: VirtualNetworkUsage[]): VirtualNetworkUsage
        • Parameters

          • previousValue: VirtualNetworkUsage
          • currentValue: VirtualNetworkUsage
          • currentIndex: number
          • array: VirtualNetworkUsage[]

          Returns VirtualNetworkUsage

    Returns VirtualNetworkUsage

  • Parameters

    • callbackfn: function
        • (previousValue: VirtualNetworkUsage, currentValue: VirtualNetworkUsage, currentIndex: number, array: VirtualNetworkUsage[]): VirtualNetworkUsage
        • Parameters

          • previousValue: VirtualNetworkUsage
          • currentValue: VirtualNetworkUsage
          • currentIndex: number
          • array: VirtualNetworkUsage[]

          Returns VirtualNetworkUsage

    • initialValue: VirtualNetworkUsage

    Returns VirtualNetworkUsage

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: VirtualNetworkUsage, currentIndex: number, array: VirtualNetworkUsage[]): U
        • Parameters

          • previousValue: U
          • currentValue: VirtualNetworkUsage
          • currentIndex: number
          • array: VirtualNetworkUsage[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): VirtualNetworkUsage[]
  • Reverses the elements in an Array.

    Returns VirtualNetworkUsage[]

shift

  • shift(): VirtualNetworkUsage | undefined
  • Removes the first element from an array and returns it.

    Returns VirtualNetworkUsage | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): VirtualNetworkUsage[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns VirtualNetworkUsage[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: VirtualNetworkUsage, index: number, array: VirtualNetworkUsage[]): boolean
        • Parameters

          • value: VirtualNetworkUsage
          • index: number
          • array: VirtualNetworkUsage[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): VirtualNetworkUsage[]
  • splice(start: number, deleteCount: number, ...items: VirtualNetworkUsage[]): VirtualNetworkUsage[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns VirtualNetworkUsage[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: VirtualNetworkUsage[]

      Elements to insert into the array in place of the deleted elements.

    Returns VirtualNetworkUsage[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: VirtualNetworkUsage[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: VirtualNetworkUsage[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<VirtualNetworkUsage>
  • Returns an iterable of values in the array

    Returns IterableIterator<VirtualNetworkUsage>

type

type: object

className

className: string = "VirtualNetworkListUsageResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VirtualNetworkUsage"

name

name: "Composite" = "Composite"

Const VirtualNetworkPeering

VirtualNetworkPeering: object

Peerings in a virtual network resource.

Optional allowForwardedTraffic

allowForwardedTraffic: undefined | false | true

Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.

Optional allowGatewayTransit

allowGatewayTransit: undefined | false | true

If gateway links can be used in remote virtual networking to link to this virtual network.

Optional allowVirtualNetworkAccess

allowVirtualNetworkAccess: undefined | false | true

Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional peeringState

The status of the virtual network peering. Possible values include: 'Initiated', 'Connected', 'Disconnected'

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the resource.

Optional remoteAddressSpace

remoteAddressSpace: AddressSpace

The reference of the remote virtual network address space.

Optional remoteVirtualNetwork

remoteVirtualNetwork: SubResource

The reference of the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering).

serializedName

serializedName: string = "VirtualNetworkPeering"

Optional useRemoteGateways

useRemoteGateways: undefined | false | true

If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway.

type

type: object

className

className: string = "VirtualNetworkPeering"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

allowForwardedTraffic

allowForwardedTraffic: object

serializedName

serializedName: string = "properties.allowForwardedTraffic"

type

type: object

name

name: "Boolean" = "Boolean"

allowGatewayTransit

allowGatewayTransit: object

serializedName

serializedName: string = "properties.allowGatewayTransit"

type

type: object

name

name: "Boolean" = "Boolean"

allowVirtualNetworkAccess

allowVirtualNetworkAccess: object

serializedName

serializedName: string = "properties.allowVirtualNetworkAccess"

type

type: object

name

name: "Boolean" = "Boolean"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

peeringState

peeringState: object

serializedName

serializedName: string = "properties.peeringState"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

remoteAddressSpace

remoteAddressSpace: object

serializedName

serializedName: string = "properties.remoteAddressSpace"

type

type: object

className

className: string = "AddressSpace"

name

name: "Composite" = "Composite"

remoteVirtualNetwork

remoteVirtualNetwork: object

serializedName

serializedName: string = "properties.remoteVirtualNetwork"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

useRemoteGateways

useRemoteGateways: object

serializedName

serializedName: string = "properties.useRemoteGateways"

type

type: object

name

name: "Boolean" = "Boolean"

Const VirtualNetworkPeeringListResult

VirtualNetworkPeeringListResult: object
interface

Response for ListSubnets API service call. Retrieves all subnets that belong to a virtual network.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "VirtualNetworkPeeringListResult"

__@iterator

  • __@iterator(): IterableIterator<VirtualNetworkPeering>
  • Iterator

    Returns IterableIterator<VirtualNetworkPeering>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<VirtualNetworkPeering>[]): VirtualNetworkPeering[]
  • concat(...items: (T | ConcatArray<T>)[]): VirtualNetworkPeering[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<VirtualNetworkPeering>[]

      Additional items to add to the end of array1.

    Returns VirtualNetworkPeering[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns VirtualNetworkPeering[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, VirtualNetworkPeering]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, VirtualNetworkPeering]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: VirtualNetworkPeering, index: number, array: VirtualNetworkPeering[]): boolean
        • Parameters

          • value: VirtualNetworkPeering
          • index: number
          • array: VirtualNetworkPeering[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: VirtualNetworkPeering, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: VirtualNetworkPeering

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): VirtualNetworkPeering[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: VirtualNetworkPeering

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkPeering, index: number, array: VirtualNetworkPeering[]): boolean
        • Parameters

          • value: VirtualNetworkPeering
          • index: number
          • array: VirtualNetworkPeering[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkPeering, index: number, array: VirtualNetworkPeering[]): any
        • Parameters

          • value: VirtualNetworkPeering
          • index: number
          • array: VirtualNetworkPeering[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns VirtualNetworkPeering[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): VirtualNetworkPeering | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: VirtualNetworkPeering

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: VirtualNetworkPeering, index: number, obj: VirtualNetworkPeering[]): boolean
        • Parameters

          • this: void
          • value: VirtualNetworkPeering
          • index: number
          • obj: VirtualNetworkPeering[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: VirtualNetworkPeering, index: number, obj: VirtualNetworkPeering[]): boolean
        • Parameters

          • value: VirtualNetworkPeering
          • index: number
          • obj: VirtualNetworkPeering[]

          Returns boolean

    • Optional thisArg: any

    Returns VirtualNetworkPeering | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: VirtualNetworkPeering, index: number, obj: VirtualNetworkPeering[]): boolean
        • Parameters

          • value: VirtualNetworkPeering
          • index: number
          • obj: VirtualNetworkPeering[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkPeering, index: number, array: VirtualNetworkPeering[]): void
        • Parameters

          • value: VirtualNetworkPeering
          • index: number
          • array: VirtualNetworkPeering[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: VirtualNetworkPeering, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: VirtualNetworkPeering

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: VirtualNetworkPeering, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: VirtualNetworkPeering

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: VirtualNetworkPeering, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: VirtualNetworkPeering

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkPeering, index: number, array: VirtualNetworkPeering[]): U
        • Parameters

          • value: VirtualNetworkPeering
          • index: number
          • array: VirtualNetworkPeering[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): VirtualNetworkPeering | undefined
  • Removes the last element from an array and returns it.

    Returns VirtualNetworkPeering | undefined

push

  • push(...items: VirtualNetworkPeering[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: VirtualNetworkPeering[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): VirtualNetworkPeering
  • reduce(callbackfn: function, initialValue: VirtualNetworkPeering): VirtualNetworkPeering
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: VirtualNetworkPeering, currentValue: VirtualNetworkPeering, currentIndex: number, array: VirtualNetworkPeering[]): VirtualNetworkPeering
        • Parameters

          • previousValue: VirtualNetworkPeering
          • currentValue: VirtualNetworkPeering
          • currentIndex: number
          • array: VirtualNetworkPeering[]

          Returns VirtualNetworkPeering

    Returns VirtualNetworkPeering

  • Parameters

    • callbackfn: function
        • (previousValue: VirtualNetworkPeering, currentValue: VirtualNetworkPeering, currentIndex: number, array: VirtualNetworkPeering[]): VirtualNetworkPeering
        • Parameters

          • previousValue: VirtualNetworkPeering
          • currentValue: VirtualNetworkPeering
          • currentIndex: number
          • array: VirtualNetworkPeering[]

          Returns VirtualNetworkPeering

    • initialValue: VirtualNetworkPeering

    Returns VirtualNetworkPeering

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: VirtualNetworkPeering, currentIndex: number, array: VirtualNetworkPeering[]): U
        • Parameters

          • previousValue: U
          • currentValue: VirtualNetworkPeering
          • currentIndex: number
          • array: VirtualNetworkPeering[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): VirtualNetworkPeering
  • reduceRight(callbackfn: function, initialValue: VirtualNetworkPeering): VirtualNetworkPeering
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: VirtualNetworkPeering, currentValue: VirtualNetworkPeering, currentIndex: number, array: VirtualNetworkPeering[]): VirtualNetworkPeering
        • Parameters

          • previousValue: VirtualNetworkPeering
          • currentValue: VirtualNetworkPeering
          • currentIndex: number
          • array: VirtualNetworkPeering[]

          Returns VirtualNetworkPeering

    Returns VirtualNetworkPeering

  • Parameters

    • callbackfn: function
        • (previousValue: VirtualNetworkPeering, currentValue: VirtualNetworkPeering, currentIndex: number, array: VirtualNetworkPeering[]): VirtualNetworkPeering
        • Parameters

          • previousValue: VirtualNetworkPeering
          • currentValue: VirtualNetworkPeering
          • currentIndex: number
          • array: VirtualNetworkPeering[]

          Returns VirtualNetworkPeering

    • initialValue: VirtualNetworkPeering

    Returns VirtualNetworkPeering

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: VirtualNetworkPeering, currentIndex: number, array: VirtualNetworkPeering[]): U
        • Parameters

          • previousValue: U
          • currentValue: VirtualNetworkPeering
          • currentIndex: number
          • array: VirtualNetworkPeering[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): VirtualNetworkPeering[]
  • Reverses the elements in an Array.

    Returns VirtualNetworkPeering[]

shift

  • shift(): VirtualNetworkPeering | undefined
  • Removes the first element from an array and returns it.

    Returns VirtualNetworkPeering | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): VirtualNetworkPeering[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns VirtualNetworkPeering[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: VirtualNetworkPeering, index: number, array: VirtualNetworkPeering[]): boolean
        • Parameters

          • value: VirtualNetworkPeering
          • index: number
          • array: VirtualNetworkPeering[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): VirtualNetworkPeering[]
  • splice(start: number, deleteCount: number, ...items: VirtualNetworkPeering[]): VirtualNetworkPeering[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns VirtualNetworkPeering[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: VirtualNetworkPeering[]

      Elements to insert into the array in place of the deleted elements.

    Returns VirtualNetworkPeering[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: VirtualNetworkPeering[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: VirtualNetworkPeering[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<VirtualNetworkPeering>
  • Returns an iterable of values in the array

    Returns IterableIterator<VirtualNetworkPeering>

type

type: object

className

className: string = "VirtualNetworkPeeringListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VirtualNetworkPeering"

name

name: "Composite" = "Composite"

Const VirtualNetworkTap

VirtualNetworkTap: object

Virtual Network Tap resource.

Optional destinationLoadBalancerFrontEndIPConfiguration

destinationLoadBalancerFrontEndIPConfiguration: FrontendIPConfiguration

The reference to the private IP address on the internal Load Balancer that will receive the tap.

Optional destinationNetworkInterfaceIPConfiguration

destinationNetworkInterfaceIPConfiguration: NetworkInterfaceIPConfiguration

The reference to the private IP Address of the collector nic that will receive the tap.

Optional destinationPort

destinationPort: undefined | number

The VXLAN destination port that will receive the tapped traffic.

Optional etag

etag: undefined | string

Gets a unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional networkInterfaceTapConfigurations

networkInterfaceTapConfigurations: NetworkInterfaceTapConfiguration[]

Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the virtual network tap. Possible values are: 'Updating', 'Deleting', and 'Failed'. NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceGuid

resourceGuid: undefined | string

The resourceGuid property of the virtual network tap. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "VirtualNetworkTap"

Optional tags

tags: undefined | object

Resource tags.

type

type: object

className

className: string = "VirtualNetworkTap"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

destinationLoadBalancerFrontEndIPConfiguration

destinationLoadBalancerFrontEndIPConfiguration: object

serializedName

serializedName: string = "properties.destinationLoadBalancerFrontEndIPConfiguration"

type

type: object

className

className: string = "FrontendIPConfiguration"

name

name: "Composite" = "Composite"

destinationNetworkInterfaceIPConfiguration

destinationNetworkInterfaceIPConfiguration: object

serializedName

serializedName: string = "properties.destinationNetworkInterfaceIPConfiguration"

type

type: object

className

className: string = "NetworkInterfaceIPConfiguration"

name

name: "Composite" = "Composite"

destinationPort

destinationPort: object

serializedName

serializedName: string = "properties.destinationPort"

type

type: object

name

name: "Number" = "Number"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

networkInterfaceTapConfigurations

networkInterfaceTapConfigurations: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.networkInterfaceTapConfigurations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NetworkInterfaceTapConfiguration"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

resourceGuid

resourceGuid: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.resourceGuid"

type

type: object

name

name: "String" = "String"

Const VirtualNetworkTapListResult

VirtualNetworkTapListResult: object
interface

Response for ListVirtualNetworkTap API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "VirtualNetworkTapListResult"

__@iterator

  • __@iterator(): IterableIterator<VirtualNetworkTap>
  • Iterator

    Returns IterableIterator<VirtualNetworkTap>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<VirtualNetworkTap>[]): VirtualNetworkTap[]
  • concat(...items: (T | ConcatArray<T>)[]): VirtualNetworkTap[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<VirtualNetworkTap>[]

      Additional items to add to the end of array1.

    Returns VirtualNetworkTap[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns VirtualNetworkTap[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, VirtualNetworkTap]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, VirtualNetworkTap]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: VirtualNetworkTap, index: number, array: VirtualNetworkTap[]): boolean
        • Parameters

          • value: VirtualNetworkTap
          • index: number
          • array: VirtualNetworkTap[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: VirtualNetworkTap, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: VirtualNetworkTap

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): VirtualNetworkTap[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: VirtualNetworkTap

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkTap, index: number, array: VirtualNetworkTap[]): boolean
        • Parameters

          • value: VirtualNetworkTap
          • index: number
          • array: VirtualNetworkTap[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkTap, index: number, array: VirtualNetworkTap[]): any
        • Parameters

          • value: VirtualNetworkTap
          • index: number
          • array: VirtualNetworkTap[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns VirtualNetworkTap[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): VirtualNetworkTap | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: VirtualNetworkTap

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: VirtualNetworkTap, index: number, obj: VirtualNetworkTap[]): boolean
        • Parameters

          • this: void
          • value: VirtualNetworkTap
          • index: number
          • obj: VirtualNetworkTap[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: VirtualNetworkTap, index: number, obj: VirtualNetworkTap[]): boolean
        • Parameters

          • value: VirtualNetworkTap
          • index: number
          • obj: VirtualNetworkTap[]

          Returns boolean

    • Optional thisArg: any

    Returns VirtualNetworkTap | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: VirtualNetworkTap, index: number, obj: VirtualNetworkTap[]): boolean
        • Parameters

          • value: VirtualNetworkTap
          • index: number
          • obj: VirtualNetworkTap[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkTap, index: number, array: VirtualNetworkTap[]): void
        • Parameters

          • value: VirtualNetworkTap
          • index: number
          • array: VirtualNetworkTap[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: VirtualNetworkTap, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: VirtualNetworkTap

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: VirtualNetworkTap, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: VirtualNetworkTap

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: VirtualNetworkTap, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: VirtualNetworkTap

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkTap, index: number, array: VirtualNetworkTap[]): U
        • Parameters

          • value: VirtualNetworkTap
          • index: number
          • array: VirtualNetworkTap[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): VirtualNetworkTap | undefined
  • Removes the last element from an array and returns it.

    Returns VirtualNetworkTap | undefined

push

  • push(...items: VirtualNetworkTap[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: VirtualNetworkTap[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): VirtualNetworkTap
  • reduce(callbackfn: function, initialValue: VirtualNetworkTap): VirtualNetworkTap
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: VirtualNetworkTap, currentValue: VirtualNetworkTap, currentIndex: number, array: VirtualNetworkTap[]): VirtualNetworkTap
        • Parameters

          • previousValue: VirtualNetworkTap
          • currentValue: VirtualNetworkTap
          • currentIndex: number
          • array: VirtualNetworkTap[]

          Returns VirtualNetworkTap

    Returns VirtualNetworkTap

  • Parameters

    • callbackfn: function
        • (previousValue: VirtualNetworkTap, currentValue: VirtualNetworkTap, currentIndex: number, array: VirtualNetworkTap[]): VirtualNetworkTap
        • Parameters

          • previousValue: VirtualNetworkTap
          • currentValue: VirtualNetworkTap
          • currentIndex: number
          • array: VirtualNetworkTap[]

          Returns VirtualNetworkTap

    • initialValue: VirtualNetworkTap

    Returns VirtualNetworkTap

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: VirtualNetworkTap, currentIndex: number, array: VirtualNetworkTap[]): U
        • Parameters

          • previousValue: U
          • currentValue: VirtualNetworkTap
          • currentIndex: number
          • array: VirtualNetworkTap[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): VirtualNetworkTap
  • reduceRight(callbackfn: function, initialValue: VirtualNetworkTap): VirtualNetworkTap
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: VirtualNetworkTap, currentValue: VirtualNetworkTap, currentIndex: number, array: VirtualNetworkTap[]): VirtualNetworkTap
        • Parameters

          • previousValue: VirtualNetworkTap
          • currentValue: VirtualNetworkTap
          • currentIndex: number
          • array: VirtualNetworkTap[]

          Returns VirtualNetworkTap

    Returns VirtualNetworkTap

  • Parameters

    • callbackfn: function
        • (previousValue: VirtualNetworkTap, currentValue: VirtualNetworkTap, currentIndex: number, array: VirtualNetworkTap[]): VirtualNetworkTap
        • Parameters

          • previousValue: VirtualNetworkTap
          • currentValue: VirtualNetworkTap
          • currentIndex: number
          • array: VirtualNetworkTap[]

          Returns VirtualNetworkTap

    • initialValue: VirtualNetworkTap

    Returns VirtualNetworkTap

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: VirtualNetworkTap, currentIndex: number, array: VirtualNetworkTap[]): U
        • Parameters

          • previousValue: U
          • currentValue: VirtualNetworkTap
          • currentIndex: number
          • array: VirtualNetworkTap[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): VirtualNetworkTap[]
  • Reverses the elements in an Array.

    Returns VirtualNetworkTap[]

shift

  • shift(): VirtualNetworkTap | undefined
  • Removes the first element from an array and returns it.

    Returns VirtualNetworkTap | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): VirtualNetworkTap[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns VirtualNetworkTap[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: VirtualNetworkTap, index: number, array: VirtualNetworkTap[]): boolean
        • Parameters

          • value: VirtualNetworkTap
          • index: number
          • array: VirtualNetworkTap[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): VirtualNetworkTap[]
  • splice(start: number, deleteCount: number, ...items: VirtualNetworkTap[]): VirtualNetworkTap[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns VirtualNetworkTap[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: VirtualNetworkTap[]

      Elements to insert into the array in place of the deleted elements.

    Returns VirtualNetworkTap[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: VirtualNetworkTap[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: VirtualNetworkTap[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<VirtualNetworkTap>
  • Returns an iterable of values in the array

    Returns IterableIterator<VirtualNetworkTap>

type

type: object

className

className: string = "VirtualNetworkTapListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VirtualNetworkTap"

name

name: "Composite" = "Composite"

Const VirtualNetworkUsage

VirtualNetworkUsage: object

Usage details for subnet.

Optional currentValue

currentValue: undefined | number

Indicates number of IPs used from the Subnet. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Subnet identifier. NOTE: This property will not be serialized. It can only be populated by the server.

Optional limit

limit: undefined | number

Indicates the size of the subnet. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

The name containing common and localized value for usage. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "VirtualNetworkUsage"

Optional unit

unit: undefined | string

Usage units. Returns 'Count'. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "VirtualNetworkUsage"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

currentValue

currentValue: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "currentValue"

type

type: object

name

name: "Number" = "Number"

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

limit

limit: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "limit"

type

type: object

name

name: "Number" = "Number"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

className

className: string = "VirtualNetworkUsageName"

name

name: "Composite" = "Composite"

unit

unit: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "unit"

type

type: object

name

name: "String" = "String"

Const VirtualNetworkUsageName

VirtualNetworkUsageName: object

Usage strings container.

Optional localizedValue

localizedValue: undefined | string

Localized subnet size and usage string. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "VirtualNetworkUsageName"

Optional value

value: undefined | string

Subnet size and usage string. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "VirtualNetworkUsageName"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

localizedValue

localizedValue: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "localizedValue"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const VirtualWAN

VirtualWAN: object

VirtualWAN Resource.

Optional allowBranchToBranchTraffic

allowBranchToBranchTraffic: undefined | false | true

True if branch to branch traffic is allowed.

Optional allowVnetToVnetTraffic

allowVnetToVnetTraffic: undefined | false | true

True if Vnet to Vnet traffic is allowed.

Optional disableVpnEncryption

disableVpnEncryption: undefined | false | true

Vpn encryption to be disabled or not.

Optional etag

etag: undefined | string

Gets a unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional office365LocalBreakoutCategory

office365LocalBreakoutCategory: OfficeTrafficCategory

The office local breakout category. Possible values include: 'Optimize', 'OptimizeAndAllow', 'All', 'None'

Optional p2SVpnServerConfigurations

p2SVpnServerConfigurations: P2SVpnServerConfiguration[]

List of all P2SVpnServerConfigurations associated with the virtual wan.

Optional provisioningState

provisioningState: ProvisioningState

The provisioning state of the resource. Possible values include: 'Succeeded', 'Updating', 'Deleting', 'Failed'

Optional securityProviderName

securityProviderName: undefined | string

The Security Provider name.

serializedName

serializedName: string = "VirtualWAN"

Optional tags

tags: undefined | object

Resource tags.

Optional virtualHubs

virtualHubs: SubResource[]

List of VirtualHubs in the VirtualWAN. NOTE: This property will not be serialized. It can only be populated by the server.

Optional vpnSites

vpnSites: SubResource[]

List of VpnSites in the VirtualWAN. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "VirtualWAN"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

allowBranchToBranchTraffic

allowBranchToBranchTraffic: object

serializedName

serializedName: string = "properties.allowBranchToBranchTraffic"

type

type: object

name

name: "Boolean" = "Boolean"

allowVnetToVnetTraffic

allowVnetToVnetTraffic: object

serializedName

serializedName: string = "properties.allowVnetToVnetTraffic"

type

type: object

name

name: "Boolean" = "Boolean"

disableVpnEncryption

disableVpnEncryption: object

serializedName

serializedName: string = "properties.disableVpnEncryption"

type

type: object

name

name: "Boolean" = "Boolean"

etag

etag: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

office365LocalBreakoutCategory

office365LocalBreakoutCategory: object

serializedName

serializedName: string = "properties.office365LocalBreakoutCategory"

type

type: object

name

name: "String" = "String"

p2SVpnServerConfigurations

p2SVpnServerConfigurations: object

serializedName

serializedName: string = "properties.p2SVpnServerConfigurations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "P2SVpnServerConfiguration"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

securityProviderName

securityProviderName: object

serializedName

serializedName: string = "properties.securityProviderName"

type

type: object

name

name: "String" = "String"

virtualHubs

virtualHubs: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.virtualHubs"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

vpnSites

vpnSites: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.vpnSites"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

Const VirtualWanSecurityProvider

VirtualWanSecurityProvider: object

Collection of SecurityProviders.

Optional name

name: undefined | string

Name of the security provider.

serializedName

serializedName: string = "VirtualWanSecurityProvider"

Optional url

url: undefined | string

Url of the security provider.

type

type: object

Name of the security provider. Possible values include: 'External', 'Native'

className

className: string = "VirtualWanSecurityProvider"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

url

url: object

serializedName

serializedName: string = "url"

type

type: object

name

name: "String" = "String"

Const VirtualWanSecurityProviders

VirtualWanSecurityProviders: object

Collection of SecurityProviders.

serializedName

serializedName: string = "VirtualWanSecurityProviders"

Optional supportedProviders

supportedProviders: VirtualWanSecurityProvider[]

List of VirtualWAN security providers.

type

type: object

className

className: string = "VirtualWanSecurityProviders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

supportedProviders

supportedProviders: object

serializedName

serializedName: string = "supportedProviders"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VirtualWanSecurityProvider"

name

name: "Composite" = "Composite"

Const VpnClientConfiguration

VpnClientConfiguration: object

VpnClientConfiguration for P2S client.

Optional aadAudience

aadAudience: undefined | string

The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication.

Optional aadIssuer

aadIssuer: undefined | string

The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication.

Optional aadTenant

aadTenant: undefined | string

The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication.

Optional radiusServerAddress

radiusServerAddress: undefined | string

The radius server address property of the VirtualNetworkGateway resource for vpn client connection.

Optional radiusServerSecret

radiusServerSecret: undefined | string

The radius secret property of the VirtualNetworkGateway resource for vpn client connection.

serializedName

serializedName: string = "VpnClientConfiguration"

Optional vpnClientAddressPool

vpnClientAddressPool: AddressSpace

The reference of the address space resource which represents Address space for P2S VpnClient.

Optional vpnClientIpsecPolicies

vpnClientIpsecPolicies: IpsecPolicy[]

VpnClientIpsecPolicies for virtual network gateway P2S client.

Optional vpnClientProtocols

vpnClientProtocols: VpnClientProtocol[]

VpnClientProtocols for Virtual network gateway.

Optional vpnClientRevokedCertificates

vpnClientRevokedCertificates: VpnClientRevokedCertificate[]

VpnClientRevokedCertificate for Virtual network gateway.

Optional vpnClientRootCertificates

vpnClientRootCertificates: VpnClientRootCertificate[]

VpnClientRootCertificate for virtual network gateway.

type

type: object

className

className: string = "VpnClientConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

aadAudience

aadAudience: object

serializedName

serializedName: string = "aadAudience"

type

type: object

name

name: "String" = "String"

aadIssuer

aadIssuer: object

serializedName

serializedName: string = "aadIssuer"

type

type: object

name

name: "String" = "String"

aadTenant

aadTenant: object

serializedName

serializedName: string = "aadTenant"

type

type: object

name

name: "String" = "String"

radiusServerAddress

radiusServerAddress: object

serializedName

serializedName: string = "radiusServerAddress"

type

type: object

name

name: "String" = "String"

radiusServerSecret

radiusServerSecret: object

serializedName

serializedName: string = "radiusServerSecret"

type

type: object

name

name: "String" = "String"

vpnClientAddressPool

vpnClientAddressPool: object

serializedName

serializedName: string = "vpnClientAddressPool"

type

type: object

className

className: string = "AddressSpace"

name

name: "Composite" = "Composite"

vpnClientIpsecPolicies

vpnClientIpsecPolicies: object

serializedName

serializedName: string = "vpnClientIpsecPolicies"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "IpsecPolicy"

name

name: "Composite" = "Composite"

vpnClientProtocols

vpnClientProtocols: object

serializedName

serializedName: string = "vpnClientProtocols"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

vpnClientRevokedCertificates

vpnClientRevokedCertificates: object

serializedName

serializedName: string = "vpnClientRevokedCertificates"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VpnClientRevokedCertificate"

name

name: "Composite" = "Composite"

vpnClientRootCertificates

vpnClientRootCertificates: object

serializedName

serializedName: string = "vpnClientRootCertificates"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VpnClientRootCertificate"

name

name: "Composite" = "Composite"

Const VpnClientConnectionHealth

VpnClientConnectionHealth: object

VpnClientConnectionHealth properties.

Optional allocatedIpAddresses

allocatedIpAddresses: string[]

List of allocated ip addresses to the connected p2s vpn clients.

serializedName

serializedName: string = "VpnClientConnectionHealth"

Optional totalEgressBytesTransferred

totalEgressBytesTransferred: undefined | number

Total of the Egress Bytes Transferred in this connection. NOTE: This property will not be serialized. It can only be populated by the server.

Optional totalIngressBytesTransferred

totalIngressBytesTransferred: undefined | number

Total of the Ingress Bytes Transferred in this P2S Vpn connection. NOTE: This property will not be serialized. It can only be populated by the server.

Optional vpnClientConnectionsCount

vpnClientConnectionsCount: undefined | number

The total of p2s vpn clients connected at this time to this P2SVpnGateway.

type

type: object

className

className: string = "VpnClientConnectionHealth"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

allocatedIpAddresses

allocatedIpAddresses: object

serializedName

serializedName: string = "allocatedIpAddresses"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

totalEgressBytesTransferred

totalEgressBytesTransferred: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "totalEgressBytesTransferred"

type

type: object

name

name: "Number" = "Number"

totalIngressBytesTransferred

totalIngressBytesTransferred: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "totalIngressBytesTransferred"

type

type: object

name

name: "Number" = "Number"

vpnClientConnectionsCount

vpnClientConnectionsCount: object

serializedName

serializedName: string = "vpnClientConnectionsCount"

type

type: object

name

name: "Number" = "Number"

Const VpnClientConnectionHealthDetail

VpnClientConnectionHealthDetail: object

VPN client connection health detail.

Optional egressBytesTransferred

egressBytesTransferred: undefined | number

The egress bytes per second. NOTE: This property will not be serialized. It can only be populated by the server.

Optional egressPacketsTransferred

egressPacketsTransferred: undefined | number

The egress packets per second. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ingressBytesTransferred

ingressBytesTransferred: undefined | number

The ingress bytes per second. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ingressPacketsTransferred

ingressPacketsTransferred: undefined | number

The ingress packets per second. NOTE: This property will not be serialized. It can only be populated by the server.

Optional maxBandwidth

maxBandwidth: undefined | number

The max band width. NOTE: This property will not be serialized. It can only be populated by the server.

Optional maxPacketsPerSecond

maxPacketsPerSecond: undefined | number

The max packets transferred per second. NOTE: This property will not be serialized. It can only be populated by the server.

Optional privateIpAddress

privateIpAddress: undefined | string

The assigned private Ip of a connected vpn client. NOTE: This property will not be serialized. It can only be populated by the server.

Optional publicIpAddress

publicIpAddress: undefined | string

The public Ip of a connected vpn client. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "VpnClientConnectionHealthDetail"

Optional vpnConnectionDuration

vpnConnectionDuration: undefined | number

The duration time of a connected vpn client. NOTE: This property will not be serialized. It can only be populated by the server.

Optional vpnConnectionId

vpnConnectionId: undefined | string

The vpn client Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional vpnConnectionTime

vpnConnectionTime: undefined | string

The start time of a connected vpn client. NOTE: This property will not be serialized. It can only be populated by the server.

Optional vpnUserName

vpnUserName: undefined | string

The user name of a connected vpn client. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "VpnClientConnectionHealthDetail"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

egressBytesTransferred

egressBytesTransferred: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "egressBytesTransferred"

type

type: object

name

name: "Number" = "Number"

egressPacketsTransferred

egressPacketsTransferred: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "egressPacketsTransferred"

type

type: object

name

name: "Number" = "Number"

ingressBytesTransferred

ingressBytesTransferred: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "ingressBytesTransferred"

type

type: object

name

name: "Number" = "Number"

ingressPacketsTransferred

ingressPacketsTransferred: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "ingressPacketsTransferred"

type

type: object

name

name: "Number" = "Number"

maxBandwidth

maxBandwidth: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "maxBandwidth"

type

type: object

name

name: "Number" = "Number"

maxPacketsPerSecond

maxPacketsPerSecond: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "maxPacketsPerSecond"

type

type: object

name

name: "Number" = "Number"

privateIpAddress

privateIpAddress: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "privateIpAddress"

type

type: object

name

name: "String" = "String"

publicIpAddress

publicIpAddress: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "publicIpAddress"

type

type: object

name

name: "String" = "String"

vpnConnectionDuration

vpnConnectionDuration: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "vpnConnectionDuration"

type

type: object

name

name: "Number" = "Number"

vpnConnectionId

vpnConnectionId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "vpnConnectionId"

type

type: object

name

name: "String" = "String"

vpnConnectionTime

vpnConnectionTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "vpnConnectionTime"

type

type: object

name

name: "String" = "String"

vpnUserName

vpnUserName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "vpnUserName"

type

type: object

name

name: "String" = "String"

Const VpnClientConnectionHealthDetailListResult

VpnClientConnectionHealthDetailListResult: object

List of virtual network gateway vpn client connection health.

serializedName

serializedName: string = "VpnClientConnectionHealthDetailListResult"

Optional value

value: VpnClientConnectionHealthDetail[]

List of vpn client connection health.

type

type: object

className

className: string = "VpnClientConnectionHealthDetailListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VpnClientConnectionHealthDetail"

name

name: "Composite" = "Composite"

Const VpnClientIPsecParameters

VpnClientIPsecParameters: object

An IPSec parameters for a virtual network gateway P2S connection.

dhGroup

dhGroup: DhGroup

The DH Group used in IKE Phase 1 for initial SA. Possible values include: 'None', 'DHGroup1', 'DHGroup2', 'DHGroup14', 'DHGroup2048', 'ECP256', 'ECP384', 'DHGroup24'

ikeEncryption

ikeEncryption: IkeEncryption

The IKE encryption algorithm (IKE phase 2). Possible values include: 'DES', 'DES3', 'AES128', 'AES192', 'AES256', 'GCMAES256', 'GCMAES128'

ikeIntegrity

ikeIntegrity: IkeIntegrity

The IKE integrity algorithm (IKE phase 2). Possible values include: 'MD5', 'SHA1', 'SHA256', 'SHA384', 'GCMAES256', 'GCMAES128'

ipsecEncryption

ipsecEncryption: IpsecEncryption

The IPSec encryption algorithm (IKE phase 1). Possible values include: 'None', 'DES', 'DES3', 'AES128', 'AES192', 'AES256', 'GCMAES128', 'GCMAES192', 'GCMAES256'

ipsecIntegrity

ipsecIntegrity: IpsecIntegrity

The IPSec integrity algorithm (IKE phase 1). Possible values include: 'MD5', 'SHA1', 'SHA256', 'GCMAES128', 'GCMAES192', 'GCMAES256'

pfsGroup

pfsGroup: PfsGroup

The Pfs Group used in IKE Phase 2 for new child SA. Possible values include: 'None', 'PFS1', 'PFS2', 'PFS2048', 'ECP256', 'ECP384', 'PFS24', 'PFS14', 'PFSMM'

saDataSizeKilobytes

saDataSizeKilobytes: number

The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for P2S client..

saLifeTimeSeconds

saLifeTimeSeconds: number

The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for P2S client.

serializedName

serializedName: string = "VpnClientIPsecParameters"

type

type: object

className

className: string = "VpnClientIPsecParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dhGroup

dhGroup: object

required

required: true = true

serializedName

serializedName: string = "dhGroup"

type

type: object

name

name: "String" = "String"

ikeEncryption

ikeEncryption: object

required

required: true = true

serializedName

serializedName: string = "ikeEncryption"

type

type: object

name

name: "String" = "String"

ikeIntegrity

ikeIntegrity: object

required

required: true = true

serializedName

serializedName: string = "ikeIntegrity"

type

type: object

name

name: "String" = "String"

ipsecEncryption

ipsecEncryption: object

required

required: true = true

serializedName

serializedName: string = "ipsecEncryption"

type

type: object

name

name: "String" = "String"

ipsecIntegrity

ipsecIntegrity: object

required

required: true = true

serializedName

serializedName: string = "ipsecIntegrity"

type

type: object

name

name: "String" = "String"

pfsGroup

pfsGroup: object

required

required: true = true

serializedName

serializedName: string = "pfsGroup"

type

type: object

name

name: "String" = "String"

saDataSizeKilobytes

saDataSizeKilobytes: object

required

required: true = true

serializedName

serializedName: string = "saDataSizeKilobytes"

type

type: object

name

name: "Number" = "Number"

saLifeTimeSeconds

saLifeTimeSeconds: object

required

required: true = true

serializedName

serializedName: string = "saLifeTimeSeconds"

type

type: object

name

name: "Number" = "Number"

Const VpnClientParameters

VpnClientParameters: object

Vpn Client Parameters for package generation.

Optional authenticationMethod

authenticationMethod: AuthenticationMethod

VPN client authentication method. Possible values include: 'EAPTLS', 'EAPMSCHAPv2'

Optional clientRootCertificates

clientRootCertificates: string[]

A list of client root certificates public certificate data encoded as Base-64 strings. Optional parameter for external radius based authentication with EAPTLS.

Optional processorArchitecture

processorArchitecture: ProcessorArchitecture

VPN client Processor Architecture. Possible values include: 'Amd64', 'X86'

Optional radiusServerAuthCertificate

radiusServerAuthCertificate: undefined | string

The public certificate data for the radius server authentication certificate as a Base-64 encoded string. Required only if external radius authentication has been configured with EAPTLS authentication.

serializedName

serializedName: string = "VpnClientParameters"

type

type: object

className

className: string = "VpnClientParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

authenticationMethod

authenticationMethod: object

serializedName

serializedName: string = "authenticationMethod"

type

type: object

name

name: "String" = "String"

clientRootCertificates

clientRootCertificates: object

serializedName

serializedName: string = "clientRootCertificates"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

processorArchitecture

processorArchitecture: object

serializedName

serializedName: string = "processorArchitecture"

type

type: object

name

name: "String" = "String"

radiusServerAuthCertificate

radiusServerAuthCertificate: object

serializedName

serializedName: string = "radiusServerAuthCertificate"

type

type: object

name

name: "String" = "String"

Const VpnClientRevokedCertificate

VpnClientRevokedCertificate: object

VPN client revoked certificate of virtual network gateway.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "VpnClientRevokedCertificate"

Optional thumbprint

thumbprint: undefined | string

The revoked VPN client certificate thumbprint.

type

type: object

className

className: string = "VpnClientRevokedCertificate"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

thumbprint

thumbprint: object

serializedName

serializedName: string = "properties.thumbprint"

type

type: object

name

name: "String" = "String"

Const VpnClientRootCertificate

VpnClientRootCertificate: object

VPN client root certificate of virtual network gateway.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. NOTE: This property will not be serialized. It can only be populated by the server.

publicCertData

publicCertData: string

The certificate public data.

serializedName

serializedName: string = "VpnClientRootCertificate"

type

type: object

className

className: string = "VpnClientRootCertificate"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

publicCertData

publicCertData: object

required

required: true = true

serializedName

serializedName: string = "properties.publicCertData"

type

type: object

name

name: "String" = "String"

Const VpnConnection

VpnConnection: object

VpnConnection Resource.

Optional connectionBandwidth

connectionBandwidth: undefined | number

Expected bandwidth in MBPS.

Optional connectionStatus

connectionStatus: VpnConnectionStatus

The connection status. Possible values include: 'Unknown', 'Connecting', 'Connected', 'NotConnected'

Optional egressBytesTransferred

egressBytesTransferred: undefined | number

Egress bytes transferred. NOTE: This property will not be serialized. It can only be populated by the server.

Optional enableBgp

enableBgp: undefined | false | true

EnableBgp flag.

Optional enableInternetSecurity

enableInternetSecurity: undefined | false | true

Enable internet security.

Optional enableRateLimiting

enableRateLimiting: undefined | false | true

EnableBgp flag.

Optional etag

etag: undefined | string

Gets a unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID.

Optional ingressBytesTransferred

ingressBytesTransferred: undefined | number

Ingress bytes transferred. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ipsecPolicies

ipsecPolicies: IpsecPolicy[]

The IPSec Policies to be considered by this connection.

Optional name

name: undefined | string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional provisioningState

provisioningState: ProvisioningState

The provisioning state of the resource. Possible values include: 'Succeeded', 'Updating', 'Deleting', 'Failed'

Optional remoteVpnSite

remoteVpnSite: SubResource

Id of the connected vpn site.

Optional routingWeight

routingWeight: undefined | number

Routing weight for vpn connection.

serializedName

serializedName: string = "VpnConnection"

Optional sharedKey

sharedKey: undefined | string

SharedKey for the vpn connection.

Optional useLocalAzureIpAddress

useLocalAzureIpAddress: undefined | false | true

Use local azure ip to initiate connection.

Optional usePolicyBasedTrafficSelectors

usePolicyBasedTrafficSelectors: undefined | false | true

Enable policy-based traffic selectors.

Optional vpnConnectionProtocolType

vpnConnectionProtocolType: VirtualNetworkGatewayConnectionProtocol

Connection protocol used for this connection. Possible values include: 'IKEv2', 'IKEv1'

type

type: object

className

className: string = "VpnConnection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

connectionBandwidth

connectionBandwidth: object

serializedName

serializedName: string = "properties.connectionBandwidth"

type

type: object

name

name: "Number" = "Number"

connectionStatus

connectionStatus: object

serializedName

serializedName: string = "properties.connectionStatus"

type

type: object

name

name: "String" = "String"

egressBytesTransferred

egressBytesTransferred: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.egressBytesTransferred"

type

type: object

name

name: "Number" = "Number"

enableBgp

enableBgp: object

serializedName

serializedName: string = "properties.enableBgp"

type

type: object

name

name: "Boolean" = "Boolean"

enableInternetSecurity

enableInternetSecurity: object

serializedName

serializedName: string = "properties.enableInternetSecurity"

type

type: object

name

name: "Boolean" = "Boolean"

enableRateLimiting

enableRateLimiting: object

serializedName

serializedName: string = "properties.enableRateLimiting"

type

type: object

name

name: "Boolean" = "Boolean"

etag

etag: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

ingressBytesTransferred

ingressBytesTransferred: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.ingressBytesTransferred"

type

type: object

name

name: "Number" = "Number"

ipsecPolicies

ipsecPolicies: object

serializedName

serializedName: string = "properties.ipsecPolicies"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "IpsecPolicy"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

remoteVpnSite

remoteVpnSite: object

serializedName

serializedName: string = "properties.remoteVpnSite"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

routingWeight

routingWeight: object

serializedName

serializedName: string = "properties.routingWeight"

type

type: object

name

name: "Number" = "Number"

sharedKey

sharedKey: object

serializedName

serializedName: string = "properties.sharedKey"

type

type: object

name

name: "String" = "String"

useLocalAzureIpAddress

useLocalAzureIpAddress: object

serializedName

serializedName: string = "properties.useLocalAzureIpAddress"

type

type: object

name

name: "Boolean" = "Boolean"

usePolicyBasedTrafficSelectors

usePolicyBasedTrafficSelectors: object

serializedName

serializedName: string = "properties.usePolicyBasedTrafficSelectors"

type

type: object

name

name: "Boolean" = "Boolean"

vpnConnectionProtocolType

vpnConnectionProtocolType: object

serializedName

serializedName: string = "properties.vpnConnectionProtocolType"

type

type: object

name

name: "String" = "String"

Const VpnDeviceScriptParameters

VpnDeviceScriptParameters: object

Vpn device configuration script generation parameters.

Optional deviceFamily

deviceFamily: undefined | string

The device family for the vpn device.

Optional firmwareVersion

firmwareVersion: undefined | string

The firmware version for the vpn device.

serializedName

serializedName: string = "VpnDeviceScriptParameters"

Optional vendor

vendor: undefined | string

The vendor for the vpn device.

type

type: object

className

className: string = "VpnDeviceScriptParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

deviceFamily

deviceFamily: object

serializedName

serializedName: string = "deviceFamily"

type

type: object

name

name: "String" = "String"

firmwareVersion

firmwareVersion: object

serializedName

serializedName: string = "firmwareVersion"

type

type: object

name

name: "String" = "String"

vendor

vendor: object

serializedName

serializedName: string = "vendor"

type

type: object

name

name: "String" = "String"

Const VpnGateway

VpnGateway: object

VpnGateway Resource.

Optional bgpSettings

bgpSettings: BgpSettings

Local network gateway's BGP speaker settings.

Optional connections

connections: VpnConnection[]

List of all vpn connections to the gateway.

Optional etag

etag: undefined | string

Gets a unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: ProvisioningState

The provisioning state of the resource. Possible values include: 'Succeeded', 'Updating', 'Deleting', 'Failed'

serializedName

serializedName: string = "VpnGateway"

Optional tags

tags: undefined | object

Resource tags.

Optional virtualHub

virtualHub: SubResource

The VirtualHub to which the gateway belongs.

Optional vpnGatewayScaleUnit

vpnGatewayScaleUnit: undefined | number

The scale unit for this vpn gateway.

type

type: object

className

className: string = "VpnGateway"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

bgpSettings

bgpSettings: object

serializedName

serializedName: string = "properties.bgpSettings"

type

type: object

className

className: string = "BgpSettings"

name

name: "Composite" = "Composite"

connections

connections: object

serializedName

serializedName: string = "properties.connections"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VpnConnection"

name

name: "Composite" = "Composite"

etag

etag: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

virtualHub

virtualHub: object

serializedName

serializedName: string = "properties.virtualHub"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

vpnGatewayScaleUnit

vpnGatewayScaleUnit: object

serializedName

serializedName: string = "properties.vpnGatewayScaleUnit"

type

type: object

name

name: "Number" = "Number"

Const VpnProfileResponse

VpnProfileResponse: object

Vpn Profile Response for package generation.

Optional profileUrl

profileUrl: undefined | string

URL to the VPN profile.

serializedName

serializedName: string = "VpnProfileResponse"

type

type: object

className

className: string = "VpnProfileResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

profileUrl

profileUrl: object

serializedName

serializedName: string = "profileUrl"

type

type: object

name

name: "String" = "String"

Const VpnSite

VpnSite: object

VpnSite Resource.

Optional addressSpace

addressSpace: AddressSpace

The AddressSpace that contains an array of IP address ranges.

Optional bgpProperties

bgpProperties: BgpSettings

The set of bgp properties.

Optional deviceProperties

deviceProperties: DeviceProperties

The device properties.

Optional etag

etag: undefined | string

Gets a unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID.

Optional ipAddress

ipAddress: undefined | string

The ip-address for the vpn-site.

Optional isSecuritySite

isSecuritySite: undefined | false | true

IsSecuritySite flag.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: ProvisioningState

The provisioning state of the resource. Possible values include: 'Succeeded', 'Updating', 'Deleting', 'Failed'

serializedName

serializedName: string = "VpnSite"

Optional siteKey

siteKey: undefined | string

The key for vpn-site that can be used for connections.

Optional tags

tags: undefined | object

Resource tags.

Optional virtualWan

virtualWan: SubResource

The VirtualWAN to which the vpnSite belongs.

type

type: object

className

className: string = "VpnSite"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

addressSpace

addressSpace: object

serializedName

serializedName: string = "properties.addressSpace"

type

type: object

className

className: string = "AddressSpace"

name

name: "Composite" = "Composite"

bgpProperties

bgpProperties: object

serializedName

serializedName: string = "properties.bgpProperties"

type

type: object

className

className: string = "BgpSettings"

name

name: "Composite" = "Composite"

deviceProperties

deviceProperties: object

serializedName

serializedName: string = "properties.deviceProperties"

type

type: object

className

className: string = "DeviceProperties"

name

name: "Composite" = "Composite"

etag

etag: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

ipAddress

ipAddress: object

serializedName

serializedName: string = "properties.ipAddress"

type

type: object

name

name: "String" = "String"

isSecuritySite

isSecuritySite: object

serializedName

serializedName: string = "properties.isSecuritySite"

type

type: object

name

name: "Boolean" = "Boolean"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

siteKey

siteKey: object

serializedName

serializedName: string = "properties.siteKey"

type

type: object

name

name: "String" = "String"

virtualWan

virtualWan: object

serializedName

serializedName: string = "properties.virtualWan"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

Const VpnSiteId

VpnSiteId: object

VpnSite Resource.

serializedName

serializedName: string = "VpnSiteId"

Optional vpnSite

vpnSite: undefined | string

The resource-uri of the vpn-site for which config is to be fetched. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "VpnSiteId"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

vpnSite

vpnSite: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "vpnSite"

type

type: object

name

name: "String" = "String"

Const WebApplicationFirewallCustomRule

WebApplicationFirewallCustomRule: object

Defines contents of a web application rule.

action

Type of Actions. Possible values include: 'Allow', 'Block', 'Log'

Optional etag

etag: undefined | string

Gets a unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

matchConditions

matchConditions: MatchCondition[]

List of match conditions.

Optional name

name: undefined | string

Gets name of the resource that is unique within a policy. This name can be used to access the resource.

priority

priority: number

Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value.

ruleType

Describes type of rule. Possible values include: 'MatchRule', 'Invalid'

serializedName

serializedName: string = "WebApplicationFirewallCustomRule"

type

type: object

className

className: string = "WebApplicationFirewallCustomRule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

action

action: object

required

required: true = true

serializedName

serializedName: string = "action"

type

type: object

name

name: "String" = "String"

etag

etag: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

matchConditions

matchConditions: object

required

required: true = true

serializedName

serializedName: string = "matchConditions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MatchCondition"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "name"

constraints

constraints: object

MaxLength

MaxLength: number = 128

type

type: object

name

name: "String" = "String"

priority

priority: object

required

required: true = true

serializedName

serializedName: string = "priority"

type

type: object

name

name: "Number" = "Number"

ruleType

ruleType: object

required

required: true = true

serializedName

serializedName: string = "ruleType"

type

type: object

name

name: "String" = "String"

Const WebApplicationFirewallPolicy

WebApplicationFirewallPolicy: object

Defines web application firewall policy.

Optional applicationGateways

applicationGateways: ApplicationGateway[]

A collection of references to application gateways. NOTE: This property will not be serialized. It can only be populated by the server.

Optional customRules

customRules: WebApplicationFirewallCustomRule[]

Describes custom rules inside the policy.

Optional etag

etag: undefined | string

Gets a unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional policySettings

policySettings: PolicySettings

Describes policySettings for policy.

Optional provisioningState

provisioningState: undefined | string

Provisioning state of the WebApplicationFirewallPolicy. NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceState

Resource status of the policy. Resource status of the policy. Possible values include: 'Creating', 'Enabling', 'Enabled', 'Disabling', 'Disabled', 'Deleting' NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "WebApplicationFirewallPolicy"

Optional tags

tags: undefined | object

Resource tags.

type

type: object

className

className: string = "WebApplicationFirewallPolicy"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicationGateways

applicationGateways: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.applicationGateways"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationGateway"

name

name: "Composite" = "Composite"

customRules

customRules: object

serializedName

serializedName: string = "properties.customRules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "WebApplicationFirewallCustomRule"

name

name: "Composite" = "Composite"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

policySettings

policySettings: object

serializedName

serializedName: string = "properties.policySettings"

type

type: object

className

className: string = "PolicySettings"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

resourceState

resourceState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.resourceState"

type

type: object

name

name: "String" = "String"

Const WebApplicationFirewallPolicyListResult

WebApplicationFirewallPolicyListResult: object
interface

Result of the request to list WebApplicationFirewallPolicies. It contains a list of WebApplicationFirewallPolicy objects and a URL link to get the the next set of results.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

URL to get the next set of WebApplicationFirewallPolicy objects if there are any. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "WebApplicationFirewallPolicyListResult"

__@iterator

  • __@iterator(): IterableIterator<WebApplicationFirewallPolicy>
  • Iterator

    Returns IterableIterator<WebApplicationFirewallPolicy>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<WebApplicationFirewallPolicy>[]): WebApplicationFirewallPolicy[]
  • concat(...items: (T | ConcatArray<T>)[]): WebApplicationFirewallPolicy[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<WebApplicationFirewallPolicy>[]

      Additional items to add to the end of array1.

    Returns WebApplicationFirewallPolicy[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns WebApplicationFirewallPolicy[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, WebApplicationFirewallPolicy]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, WebApplicationFirewallPolicy]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: WebApplicationFirewallPolicy, index: number, array: WebApplicationFirewallPolicy[]): boolean
        • Parameters

          • value: WebApplicationFirewallPolicy
          • index: number
          • array: WebApplicationFirewallPolicy[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: WebApplicationFirewallPolicy, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: WebApplicationFirewallPolicy

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): WebApplicationFirewallPolicy[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: WebApplicationFirewallPolicy

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: WebApplicationFirewallPolicy, index: number, array: WebApplicationFirewallPolicy[]): boolean
        • Parameters

          • value: WebApplicationFirewallPolicy
          • index: number
          • array: WebApplicationFirewallPolicy[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: WebApplicationFirewallPolicy, index: number, array: WebApplicationFirewallPolicy[]): any
        • Parameters

          • value: WebApplicationFirewallPolicy
          • index: number
          • array: WebApplicationFirewallPolicy[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns WebApplicationFirewallPolicy[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): WebApplicationFirewallPolicy | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: WebApplicationFirewallPolicy

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: WebApplicationFirewallPolicy, index: number, obj: WebApplicationFirewallPolicy[]): boolean
        • Parameters

          • this: void
          • value: WebApplicationFirewallPolicy
          • index: number
          • obj: WebApplicationFirewallPolicy[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: WebApplicationFirewallPolicy, index: number, obj: WebApplicationFirewallPolicy[]): boolean
        • Parameters

          • value: WebApplicationFirewallPolicy
          • index: number
          • obj: WebApplicationFirewallPolicy[]

          Returns boolean

    • Optional thisArg: any

    Returns WebApplicationFirewallPolicy | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: WebApplicationFirewallPolicy, index: number, obj: WebApplicationFirewallPolicy[]): boolean
        • Parameters

          • value: WebApplicationFirewallPolicy
          • index: number
          • obj: WebApplicationFirewallPolicy[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: WebApplicationFirewallPolicy, index: number, array: WebApplicationFirewallPolicy[]): void
        • Parameters

          • value: WebApplicationFirewallPolicy
          • index: number
          • array: WebApplicationFirewallPolicy[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: WebApplicationFirewallPolicy, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: WebApplicationFirewallPolicy

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: WebApplicationFirewallPolicy, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: WebApplicationFirewallPolicy

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: WebApplicationFirewallPolicy, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: WebApplicationFirewallPolicy

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: WebApplicationFirewallPolicy, index: number, array: WebApplicationFirewallPolicy[]): U
        • Parameters

          • value: WebApplicationFirewallPolicy
          • index: number
          • array: WebApplicationFirewallPolicy[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): WebApplicationFirewallPolicy | undefined
  • Removes the last element from an array and returns it.

    Returns WebApplicationFirewallPolicy | undefined

push

  • push(...items: WebApplicationFirewallPolicy[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: WebApplicationFirewallPolicy[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): WebApplicationFirewallPolicy
  • reduce(callbackfn: function, initialValue: WebApplicationFirewallPolicy): WebApplicationFirewallPolicy
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: WebApplicationFirewallPolicy, currentValue: WebApplicationFirewallPolicy, currentIndex: number, array: WebApplicationFirewallPolicy[]): WebApplicationFirewallPolicy
        • Parameters

          • previousValue: WebApplicationFirewallPolicy
          • currentValue: WebApplicationFirewallPolicy
          • currentIndex: number
          • array: WebApplicationFirewallPolicy[]

          Returns WebApplicationFirewallPolicy

    Returns WebApplicationFirewallPolicy

  • Parameters

    • callbackfn: function
        • (previousValue: WebApplicationFirewallPolicy, currentValue: WebApplicationFirewallPolicy, currentIndex: number, array: WebApplicationFirewallPolicy[]): WebApplicationFirewallPolicy
        • Parameters

          • previousValue: WebApplicationFirewallPolicy
          • currentValue: WebApplicationFirewallPolicy
          • currentIndex: number
          • array: WebApplicationFirewallPolicy[]

          Returns WebApplicationFirewallPolicy

    • initialValue: WebApplicationFirewallPolicy

    Returns WebApplicationFirewallPolicy

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: WebApplicationFirewallPolicy, currentIndex: number, array: WebApplicationFirewallPolicy[]): U
        • Parameters

          • previousValue: U
          • currentValue: WebApplicationFirewallPolicy
          • currentIndex: number
          • array: WebApplicationFirewallPolicy[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): WebApplicationFirewallPolicy
  • reduceRight(callbackfn: function, initialValue: WebApplicationFirewallPolicy): WebApplicationFirewallPolicy
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: WebApplicationFirewallPolicy, currentValue: WebApplicationFirewallPolicy, currentIndex: number, array: WebApplicationFirewallPolicy[]): WebApplicationFirewallPolicy
        • Parameters

          • previousValue: WebApplicationFirewallPolicy
          • currentValue: WebApplicationFirewallPolicy
          • currentIndex: number
          • array: WebApplicationFirewallPolicy[]

          Returns WebApplicationFirewallPolicy

    Returns WebApplicationFirewallPolicy

  • Parameters

    • callbackfn: function
        • (previousValue: WebApplicationFirewallPolicy, currentValue: WebApplicationFirewallPolicy, currentIndex: number, array: WebApplicationFirewallPolicy[]): WebApplicationFirewallPolicy
        • Parameters

          • previousValue: WebApplicationFirewallPolicy
          • currentValue: WebApplicationFirewallPolicy
          • currentIndex: number
          • array: WebApplicationFirewallPolicy[]

          Returns WebApplicationFirewallPolicy

    • initialValue: WebApplicationFirewallPolicy

    Returns WebApplicationFirewallPolicy

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: WebApplicationFirewallPolicy, currentIndex: number, array: WebApplicationFirewallPolicy[]): U
        • Parameters

          • previousValue: U
          • currentValue: WebApplicationFirewallPolicy
          • currentIndex: number
          • array: WebApplicationFirewallPolicy[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): WebApplicationFirewallPolicy[]
  • Reverses the elements in an Array.

    Returns WebApplicationFirewallPolicy[]

shift

  • shift(): WebApplicationFirewallPolicy | undefined
  • Removes the first element from an array and returns it.

    Returns WebApplicationFirewallPolicy | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): WebApplicationFirewallPolicy[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns WebApplicationFirewallPolicy[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: WebApplicationFirewallPolicy, index: number, array: WebApplicationFirewallPolicy[]): boolean
        • Parameters

          • value: WebApplicationFirewallPolicy
          • index: number
          • array: WebApplicationFirewallPolicy[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): WebApplicationFirewallPolicy[]
  • splice(start: number, deleteCount: number, ...items: WebApplicationFirewallPolicy[]): WebApplicationFirewallPolicy[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns WebApplicationFirewallPolicy[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: WebApplicationFirewallPolicy[]

      Elements to insert into the array in place of the deleted elements.

    Returns WebApplicationFirewallPolicy[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: WebApplicationFirewallPolicy[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: WebApplicationFirewallPolicy[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<WebApplicationFirewallPolicy>
  • Returns an iterable of values in the array

    Returns IterableIterator<WebApplicationFirewallPolicy>

type

type: object

className

className: string = "WebApplicationFirewallPolicyListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "WebApplicationFirewallPolicy"

name

name: "Composite" = "Composite"

Const acceptLanguage

acceptLanguage: object

parameterPath

parameterPath: string = "acceptLanguage"

mapper

mapper: object

defaultValue

defaultValue: string = "en-US"

serializedName

serializedName: string = "accept-language"

type

type: object

name

name: "String" = "String"

Const apiVersion0

apiVersion0: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "2019-04-01"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: "String" = "String"

Const apiVersion1

apiVersion1: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "2017-03-30"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: "String" = "String"

Const applicationGatewayName

applicationGatewayName: object

parameterPath

parameterPath: string = "applicationGatewayName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "applicationGatewayName"

type

type: object

name

name: "String" = "String"

Const applicationSecurityGroupName

applicationSecurityGroupName: object

parameterPath

parameterPath: string = "applicationSecurityGroupName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "applicationSecurityGroupName"

type

type: object

name

name: "String" = "String"

Const authorizationName

authorizationName: object

parameterPath

parameterPath: string = "authorizationName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "authorizationName"

type

type: object

name

name: "String" = "String"

Const azureFirewallName

azureFirewallName: object

parameterPath

parameterPath: string = "azureFirewallName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "azureFirewallName"

type

type: object

name

name: "String" = "String"

Const backendAddressPoolName

backendAddressPoolName: object

parameterPath

parameterPath: string = "backendAddressPoolName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "backendAddressPoolName"

type

type: object

name

name: "String" = "String"

Const bastionHostName

bastionHostName: object

parameterPath

parameterPath: string = "bastionHostName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "bastionHostName"

type

type: object

name

name: "String" = "String"

Const circuitName

circuitName: object

parameterPath

parameterPath: string = "circuitName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "circuitName"

type

type: object

name

name: "String" = "String"

Const connectionMonitorName

connectionMonitorName: object

parameterPath

parameterPath: string = "connectionMonitorName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "connectionMonitorName"

type

type: object

name

name: "String" = "String"

Const connectionName

connectionName: object

parameterPath

parameterPath: string = "connectionName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "connectionName"

type

type: object

name

name: "String" = "String"

Const crossConnectionName

crossConnectionName: object

parameterPath

parameterPath: string = "crossConnectionName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "crossConnectionName"

type

type: object

name

name: "String" = "String"

Const ddosCustomPolicyName

ddosCustomPolicyName: object

parameterPath

parameterPath: string = "ddosCustomPolicyName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "ddosCustomPolicyName"

type

type: object

name

name: "String" = "String"

Const ddosProtectionPlanName

ddosProtectionPlanName: object

parameterPath

parameterPath: string = "ddosProtectionPlanName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "ddosProtectionPlanName"

type

type: object

name

name: "String" = "String"

Const defaultSecurityRuleName

defaultSecurityRuleName: object

parameterPath

parameterPath: string = "defaultSecurityRuleName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "defaultSecurityRuleName"

type

type: object

name

name: "String" = "String"

Const devicePath

devicePath: object

parameterPath

parameterPath: string = "devicePath"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "devicePath"

type

type: object

name

name: "String" = "String"

Const domainNameLabel

domainNameLabel: object

parameterPath

parameterPath: string = "domainNameLabel"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "domainNameLabel"

type

type: object

name

name: "String" = "String"

Const expand

expand: object

parameterPath

parameterPath: string[] = ["options","expand"]

mapper

mapper: object

serializedName

serializedName: string = "$expand"

type

type: object

name

name: "String" = "String"

Const expressRouteGatewayName

expressRouteGatewayName: object

parameterPath

parameterPath: string = "expressRouteGatewayName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "expressRouteGatewayName"

type

type: object

name

name: "String" = "String"

Const expressRoutePortName

expressRoutePortName: object

parameterPath

parameterPath: string = "expressRoutePortName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "expressRoutePortName"

type

type: object

name

name: "String" = "String"

Const frontendIPConfigurationName

frontendIPConfigurationName: object

parameterPath

parameterPath: string = "frontendIPConfigurationName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "frontendIPConfigurationName"

type

type: object

name

name: "String" = "String"

Const gatewayName

gatewayName: object

parameterPath

parameterPath: string = "gatewayName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "gatewayName"

type

type: object

name

name: "String" = "String"

Const gatewayVip

gatewayVip: object

parameterPath

parameterPath: string[] = ["options","gatewayVip"]

mapper

mapper: object

serializedName

serializedName: string = "gatewayVip"

type

type: object

name

name: "String" = "String"

Const inboundNatRuleName

inboundNatRuleName: object

parameterPath

parameterPath: string = "inboundNatRuleName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "inboundNatRuleName"

type

type: object

name

name: "String" = "String"

Const ipAddress

ipAddress: object

parameterPath

parameterPath: string = "ipAddress"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "ipAddress"

type

type: object

name

name: "String" = "String"

Const ipConfigurationName

ipConfigurationName: object

parameterPath

parameterPath: string = "ipConfigurationName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "ipConfigurationName"

type

type: object

name

name: "String" = "String"

Const linkName

linkName: object

parameterPath

parameterPath: string = "linkName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "linkName"

type

type: object

name

name: "String" = "String"

Const loadBalancerName

loadBalancerName: object

parameterPath

parameterPath: string = "loadBalancerName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "loadBalancerName"

type

type: object

name

name: "String" = "String"

Const loadBalancingRuleName

loadBalancingRuleName: object

parameterPath

parameterPath: string = "loadBalancingRuleName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "loadBalancingRuleName"

type

type: object

name

name: "String" = "String"

Const localNetworkGatewayName

localNetworkGatewayName: object

parameterPath

parameterPath: string = "localNetworkGatewayName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "localNetworkGatewayName"

constraints

constraints: object

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

Const location0

location0: object

parameterPath

parameterPath: string = "location"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

Const location1

location1: object

parameterPath

parameterPath: string = "location"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "location"

constraints

constraints: object

Pattern

Pattern: RegExp = /^[-\w\._ ]+$/

type

type: object

name

name: "String" = "String"

Const locationName

locationName: object

parameterPath

parameterPath: string = "locationName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "locationName"

type

type: object

name

name: "String" = "String"

Const natGatewayName

natGatewayName: object

parameterPath

parameterPath: string = "natGatewayName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "natGatewayName"

type

type: object

name

name: "String" = "String"

Const networkInterfaceName

networkInterfaceName: object

parameterPath

parameterPath: string = "networkInterfaceName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "networkInterfaceName"

type

type: object

name

name: "String" = "String"

Const networkProfileName

networkProfileName: object

parameterPath

parameterPath: string = "networkProfileName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "networkProfileName"

type

type: object

name

name: "String" = "String"

Const networkSecurityGroupName

networkSecurityGroupName: object

parameterPath

parameterPath: string = "networkSecurityGroupName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "networkSecurityGroupName"

type

type: object

name

name: "String" = "String"

Const networkWatcherName

networkWatcherName: object

parameterPath

parameterPath: string = "networkWatcherName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "networkWatcherName"

type

type: object

name

name: "String" = "String"

Const nextPageLink

nextPageLink: object

parameterPath

parameterPath: string = "nextPageLink"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

Const outboundRuleName

outboundRuleName: object

parameterPath

parameterPath: string = "outboundRuleName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "outboundRuleName"

type

type: object

name

name: "String" = "String"

Const p2SVpnServerConfigurationName

p2SVpnServerConfigurationName: object

parameterPath

parameterPath: string = "p2SVpnServerConfigurationName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "p2SVpnServerConfigurationName"

type

type: object

name

name: "String" = "String"

Const packetCaptureName

packetCaptureName: object

parameterPath

parameterPath: string = "packetCaptureName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "packetCaptureName"

type

type: object

name

name: "String" = "String"

Const peConnectionName

peConnectionName: object

parameterPath

parameterPath: string = "peConnectionName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "peConnectionName"

type

type: object

name

name: "String" = "String"

Const peer0

peer0: object

parameterPath

parameterPath: string[] = ["options","peer"]

mapper

mapper: object

serializedName

serializedName: string = "peer"

type

type: object

name

name: "String" = "String"

Const peer1

peer1: object

parameterPath

parameterPath: string = "peer"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "peer"

type

type: object

name

name: "String" = "String"

Const peeringName

peeringName: object

parameterPath

parameterPath: string = "peeringName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "peeringName"

type

type: object

name

name: "String" = "String"

Const policyName

policyName: object

parameterPath

parameterPath: string = "policyName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "policyName"

constraints

constraints: object

MaxLength

MaxLength: number = 128

type

type: object

name

name: "String" = "String"

Const predefinedPolicyName

predefinedPolicyName: object

parameterPath

parameterPath: string = "predefinedPolicyName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "predefinedPolicyName"

type

type: object

name

name: "String" = "String"

Const privateEndpointName

privateEndpointName: object

parameterPath

parameterPath: string = "privateEndpointName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "privateEndpointName"

type

type: object

name

name: "String" = "String"

Const probeName

probeName: object

parameterPath

parameterPath: string = "probeName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "probeName"

type

type: object

name

name: "String" = "String"

Const publicIpAddressName

publicIpAddressName: object

parameterPath

parameterPath: string = "publicIpAddressName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "publicIpAddressName"

type

type: object

name

name: "String" = "String"

Const publicIpPrefixName

publicIpPrefixName: object

parameterPath

parameterPath: string = "publicIpPrefixName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "publicIpPrefixName"

type

type: object

name

name: "String" = "String"

Const resourceGroupName

resourceGroupName: object

parameterPath

parameterPath: string = "resourceGroupName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "resourceGroupName"

type

type: object

name

name: "String" = "String"

Const routeFilterName

routeFilterName: object

parameterPath

parameterPath: string = "routeFilterName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "routeFilterName"

type

type: object

name

name: "String" = "String"

Const routeName

routeName: object

parameterPath

parameterPath: string = "routeName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "routeName"

type

type: object

name

name: "String" = "String"

Const routeTableName

routeTableName: object

parameterPath

parameterPath: string = "routeTableName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "routeTableName"

type

type: object

name

name: "String" = "String"

Const ruleName

ruleName: object

parameterPath

parameterPath: string = "ruleName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "ruleName"

type

type: object

name

name: "String" = "String"

Const securityRuleName

securityRuleName: object

parameterPath

parameterPath: string = "securityRuleName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "securityRuleName"

type

type: object

name

name: "String" = "String"

Const serviceEndpointPolicyDefinitionName

serviceEndpointPolicyDefinitionName: object

parameterPath

parameterPath: string = "serviceEndpointPolicyDefinitionName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "serviceEndpointPolicyDefinitionName"

type

type: object

name

name: "String" = "String"

Const serviceEndpointPolicyName

serviceEndpointPolicyName: object

parameterPath

parameterPath: string = "serviceEndpointPolicyName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "serviceEndpointPolicyName"

type

type: object

name

name: "String" = "String"

Const serviceName

serviceName: object

parameterPath

parameterPath: string = "serviceName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "serviceName"

type

type: object

name

name: "String" = "String"

Const subnetName

subnetName: object

parameterPath

parameterPath: string = "subnetName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "subnetName"

type

type: object

name

name: "String" = "String"

Const subscriptionId

subscriptionId: object

parameterPath

parameterPath: string = "subscriptionId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "subscriptionId"

type

type: object

name

name: "String" = "String"

Const tapConfigurationName

tapConfigurationName: object

parameterPath

parameterPath: string = "tapConfigurationName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "tapConfigurationName"

type

type: object

name

name: "String" = "String"

Const tapName

tapName: object

parameterPath

parameterPath: string = "tapName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "tapName"

type

type: object

name

name: "String" = "String"

Const virtualHubName

virtualHubName: object

parameterPath

parameterPath: string = "virtualHubName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "virtualHubName"

type

type: object

name

name: "String" = "String"

Const virtualMachineScaleSetName

virtualMachineScaleSetName: object

parameterPath

parameterPath: string = "virtualMachineScaleSetName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "virtualMachineScaleSetName"

type

type: object

name

name: "String" = "String"

Const virtualNetworkGatewayConnectionName

virtualNetworkGatewayConnectionName: object

parameterPath

parameterPath: string = "virtualNetworkGatewayConnectionName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "virtualNetworkGatewayConnectionName"

type

type: object

name

name: "String" = "String"

Const virtualNetworkGatewayName

virtualNetworkGatewayName: object

parameterPath

parameterPath: string = "virtualNetworkGatewayName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "virtualNetworkGatewayName"

type

type: object

name

name: "String" = "String"

Const virtualNetworkName

virtualNetworkName: object

parameterPath

parameterPath: string = "virtualNetworkName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "virtualNetworkName"

type

type: object

name

name: "String" = "String"

Const virtualNetworkPeeringName

virtualNetworkPeeringName: object

parameterPath

parameterPath: string = "virtualNetworkPeeringName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "virtualNetworkPeeringName"

type

type: object

name

name: "String" = "String"

Const virtualWANName0

virtualWANName0: object

parameterPath

parameterPath: string = "virtualWANName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "virtualWANName"

type

type: object

name

name: "String" = "String"

Const virtualWANName1

virtualWANName1: object

parameterPath

parameterPath: string = "virtualWANName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "VirtualWANName"

type

type: object

name

name: "String" = "String"

Const virtualWanName

virtualWanName: object

parameterPath

parameterPath: string = "virtualWanName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "virtualWanName"

type

type: object

name

name: "String" = "String"

Const virtualmachineIndex

virtualmachineIndex: object

parameterPath

parameterPath: string = "virtualmachineIndex"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "virtualmachineIndex"

type

type: object

name

name: "String" = "String"

Const vpnSiteName

vpnSiteName: object

parameterPath

parameterPath: string = "vpnSiteName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "vpnSiteName"

type

type: object

name

name: "String" = "String"

Generated using TypeDoc